diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml new file mode 100644 index 0000000000..c70f9fc643 --- /dev/null +++ b/.github/workflows/publish.yml @@ -0,0 +1,21 @@ +name: Publish to PyPI.org +on: + release: + types: [released] +jobs: + release: + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v3 + with: + fetch-depth: 0 + - uses: actions/setup-python@v4 + with: + python-version: '3.10' + cache: 'pip' # caching pip dependencies + - run: pip install --upgrade build && python3 -m build + - name: Publish package + uses: pypa/gh-action-pypi-publish@release/v1 + with: + password: ${{ secrets.PYPI_API_TOKEN }} diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml new file mode 100644 index 0000000000..53e5dae09f --- /dev/null +++ b/.github/workflows/release.yml @@ -0,0 +1,19 @@ +name: Release + +on: + push: + branches: + - main + +jobs: + release: + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v3 + - name: Create Release + id: create_release + uses: ncipollo/release-action@v1 + with: + commit: main + tag: 0.0.1 diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml new file mode 100644 index 0000000000..491e45484a --- /dev/null +++ b/.github/workflows/test.yml @@ -0,0 +1,30 @@ +name: Unit Test + +on: + pull_request: + +jobs: + test: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + - uses: actions/setup-python@v4 + with: + python-version: '3.10' + cache: 'pip' # caching pip dependencies + + - name: Install dependencies + run: | + python -m pip install --upgrade pip + pip install pytest urllib3 python-dateutil + pip install -e . + + - name: Unit Test + run: pytest + + - name: Automerge + uses: pascalgn/automerge-action@v0.15.3 + env: + GITHUB_TOKEN: '${{ secrets.GITHUB_TOKEN }}' + MERGE_LABELS: '' + MERGE_METHOD: squash diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000000..43995bd42f --- /dev/null +++ b/.gitignore @@ -0,0 +1,66 @@ +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[cod] +*$py.class + +# C extensions +*.so + +# Distribution / packaging +.Python +env/ +build/ +develop-eggs/ +dist/ +downloads/ +eggs/ +.eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +*.egg-info/ +.installed.cfg +*.egg + +# PyInstaller +# Usually these files are written by a python script from a template +# before PyInstaller builds the exe, so as to inject date/other infos into it. +*.manifest +*.spec + +# Installer logs +pip-log.txt +pip-delete-this-directory.txt + +# Unit test / coverage reports +htmlcov/ +.tox/ +.coverage +.coverage.* +.cache +nosetests.xml +coverage.xml +*,cover +.hypothesis/ +venv/ +.venv/ +.python-version +.pytest_cache + +# Translations +*.mo +*.pot + +# Django stuff: +*.log + +# Sphinx documentation +docs/_build/ + +# PyBuilder +target/ + +#Ipython Notebook +.ipynb_checkpoints diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000000..52082c21ec --- /dev/null +++ b/LICENSE @@ -0,0 +1,13 @@ +Copyright 2022 Apideck (https://apideck.com) + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. diff --git a/README.md b/README.md new file mode 100644 index 0000000000..878d87fa22 --- /dev/null +++ b/README.md @@ -0,0 +1,1320 @@ +# Apideck Python SDK + +## Table of Contents + +- [Table of Contents](#table-of-contents) +- [Installation](#installation--usage) +- [Getting started](#getting-started) +- [Example](#example) +- [Support](#support) +- [License](#license) + +## Requirements. + +Python >=3.6 + +## Installation & Usage +### pip install + +If the python package is hosted on a repository, you can install directly using: + +```sh +pip install git+https://github.com/apideck-libraries/python-sdk.git +``` +(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/apideck-libraries/python-sdk.git`) + +Then import the package: +```python +import apideck +``` + +### Setuptools + +Install via [Setuptools](http://pypi.python.org/pypi/setuptools). + +```sh +python setup.py install --user +``` +(or `sudo python setup.py install` to install the package for all users) + +Then import the package: +```python +import apideck +``` + +## Getting started + +The module supports all Apideck API endpoints. For complete information about the API, head +to the [docs][2]. + +## Example + +Retrieving a list of all contacts and updating the first record with a new address. + +```python +import apideck +from apideck.api import crm_api +from apideck.model.contacts_sort import ContactsSort +from apideck.model.sort_direction import SortDirection +from pprint import pprint + +configuration = apideck.Configuration() + +configuration.api_key['apiKey'] = '' +configuration.api_key_prefix['apiKey'] = 'Bearer' + +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = crm_api.CrmApi(api_client) + raw = False + consumer_id = '' + app_id = '' + service_id = '' + limit = 20 + + sort = ContactsSort( + by="name", + direction=SortDirection("asc"), + ) + + + try: + # List contacts + api_response = api_instance.contacts_all(raw=raw, consumer_id=consumer_id, app_id=app_id, service_id=service_id, limit=limit, sort=sort) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling CrmApi->contacts_all: %s\n" % e) +``` + +## Apideck Unified Apis + +The following Apis are currently available: + +### AccountingApi + +Read the full documentation of the AccountingApi [here](./docs/apis/AccountingApi.md). + +### AtsApi + +Read the full documentation of the AtsApi [here](./docs/apis/AtsApi.md). + +### ConnectorApi + +Read the full documentation of the ConnectorApi [here](./docs/apis/ConnectorApi.md). + +### CrmApi + +Read the full documentation of the CrmApi [here](./docs/apis/CrmApi.md). + +### CustomerSupportApi + +Read the full documentation of the CustomerSupportApi [here](./docs/apis/CustomerSupportApi.md). + +### FileStorageApi + +Read the full documentation of the FileStorageApi [here](./docs/apis/FileStorageApi.md). + +### HrisApi + +Read the full documentation of the HrisApi [here](./docs/apis/HrisApi.md). + +### LeadApi + +Read the full documentation of the LeadApi [here](./docs/apis/LeadApi.md). + +### PosApi + +Read the full documentation of the PosApi [here](./docs/apis/PosApi.md). + +### SmsApi + +Read the full documentation of the SmsApi [here](./docs/apis/SmsApi.md). + +### VaultApi + +Read the full documentation of the VaultApi [here](./docs/apis/VaultApi.md). + +### WebhookApi + +Read the full documentation of the WebhookApi [here](./docs/apis/WebhookApi.md). + + +### Utils + +#### uploadFile + +A utility for uploading files using the File Storage API. `uploadFile` will automatically use upload sessions for files larger than 4MB. Smaller files will be uploaded with a simple upload call. + +**Example Usage** + + +## Support + +Open an [issue][3]! + +## License + +[Apache-2.0][4] + +[1]: https://apideck.com +[2]: https://developers.apideck.com/ +[3]: https://github.com/apideck-libraries/python-sdk/issues/new +[4]: https://github.com/apideck-libraries/python-sdk/blob/master/LICENSE + + +```python + +import time +import apideck +from pprint import pprint +from apideck.api import accounting_api +from apideck.model.accounting_customer import AccountingCustomer +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.balance_sheet_filter import BalanceSheetFilter +from apideck.model.bill import Bill +from apideck.model.create_bill_response import CreateBillResponse +from apideck.model.create_credit_note_response import CreateCreditNoteResponse +from apideck.model.create_customer_response import CreateCustomerResponse +from apideck.model.create_invoice_item_response import CreateInvoiceItemResponse +from apideck.model.create_invoice_response import CreateInvoiceResponse +from apideck.model.create_ledger_account_response import CreateLedgerAccountResponse +from apideck.model.create_payment_response import CreatePaymentResponse +from apideck.model.create_supplier_response import CreateSupplierResponse +from apideck.model.create_tax_rate_response import CreateTaxRateResponse +from apideck.model.credit_note import CreditNote +from apideck.model.customers_filter import CustomersFilter +from apideck.model.delete_bill_response import DeleteBillResponse +from apideck.model.delete_credit_note_response import DeleteCreditNoteResponse +from apideck.model.delete_customer_response import DeleteCustomerResponse +from apideck.model.delete_invoice_response import DeleteInvoiceResponse +from apideck.model.delete_ledger_account_response import DeleteLedgerAccountResponse +from apideck.model.delete_payment_response import DeletePaymentResponse +from apideck.model.delete_supplier_response import DeleteSupplierResponse +from apideck.model.delete_tax_rate_response import DeleteTaxRateResponse +from apideck.model.get_balance_sheet_response import GetBalanceSheetResponse +from apideck.model.get_bill_response import GetBillResponse +from apideck.model.get_bills_response import GetBillsResponse +from apideck.model.get_company_info_response import GetCompanyInfoResponse +from apideck.model.get_credit_note_response import GetCreditNoteResponse +from apideck.model.get_credit_notes_response import GetCreditNotesResponse +from apideck.model.get_customer_response import GetCustomerResponse +from apideck.model.get_customers_response import GetCustomersResponse +from apideck.model.get_invoice_item_response import GetInvoiceItemResponse +from apideck.model.get_invoice_items_response import GetInvoiceItemsResponse +from apideck.model.get_invoice_response import GetInvoiceResponse +from apideck.model.get_invoices_response import GetInvoicesResponse +from apideck.model.get_ledger_account_response import GetLedgerAccountResponse +from apideck.model.get_ledger_accounts_response import GetLedgerAccountsResponse +from apideck.model.get_payment_response import GetPaymentResponse +from apideck.model.get_payments_response import GetPaymentsResponse +from apideck.model.get_profit_and_loss_response import GetProfitAndLossResponse +from apideck.model.get_supplier_response import GetSupplierResponse +from apideck.model.get_suppliers_response import GetSuppliersResponse +from apideck.model.get_tax_rate_response import GetTaxRateResponse +from apideck.model.get_tax_rates_response import GetTaxRatesResponse +from apideck.model.invoice import Invoice +from apideck.model.invoice_item import InvoiceItem +from apideck.model.invoice_items_filter import InvoiceItemsFilter +from apideck.model.invoices_sort import InvoicesSort +from apideck.model.ledger_account import LedgerAccount +from apideck.model.not_found_response import NotFoundResponse +from apideck.model.passthrough import Passthrough +from apideck.model.payment import Payment +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.profit_and_loss_filter import ProfitAndLossFilter +from apideck.model.supplier import Supplier +from apideck.model.tax_rate import TaxRate +from apideck.model.tax_rates_filter import TaxRatesFilter +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.update_bill_response import UpdateBillResponse +from apideck.model.update_credit_note_response import UpdateCreditNoteResponse +from apideck.model.update_customer_response import UpdateCustomerResponse +from apideck.model.update_invoice_items_response import UpdateInvoiceItemsResponse +from apideck.model.update_invoice_response import UpdateInvoiceResponse +from apideck.model.update_ledger_account_response import UpdateLedgerAccountResponse +from apideck.model.update_payment_response import UpdatePaymentResponse +from apideck.model.update_supplier_response import UpdateSupplierResponse +from apideck.model.update_tax_rate_response import UpdateTaxRateResponse +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = accounting_api.AccountingApi(api_client) + x_apideck_consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) +x_apideck_app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) +x_apideck_service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) +pass_through = Passthrough() # Passthrough | Optional unmapped key/values that will be passed through to downstream as query parameters (optional) +filter = BalanceSheetFilter( + start_date="2021-01-01", + end_date="2021-12-31", + ) # BalanceSheetFilter | Apply filters (optional) +raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) (default to False) + + try: + # Get BalanceSheet + api_response = api_instance.balance_sheet_one(x_apideck_consumer_id=x_apideck_consumer_id, x_apideck_app_id=x_apideck_app_id, x_apideck_service_id=x_apideck_service_id, pass_through=pass_through, filter=filter, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling AccountingApi->balance_sheet_one: %s\n" % e) +``` + +## Documentation for API Endpoints + +All URIs are relative to _https://unify.apideck.com_ + +| Class | Method | HTTP request | Description | +| ----------------------------------------------------------------- | ------------------------------------------------------------------------------ | --------------------------- | ----------- | +| _AccountingApi_ | [**balance_sheet_one**](docs/apis/AccountingApi.md#balance_sheet_one) | **GET** /accounting/balance-sheet | Get BalanceSheet | + +_AccountingApi_ | [**bills_add**](docs/apis/AccountingApi.md#bills_add) | **POST** /accounting/bills | Create Bill | + +_AccountingApi_ | [**bills_all**](docs/apis/AccountingApi.md#bills_all) | **GET** /accounting/bills | List Bills | + +_AccountingApi_ | [**bills_delete**](docs/apis/AccountingApi.md#bills_delete) | **DELETE** /accounting/bills/{id} | Delete Bill | + +_AccountingApi_ | [**bills_one**](docs/apis/AccountingApi.md#bills_one) | **GET** /accounting/bills/{id} | Get Bill | + +_AccountingApi_ | [**bills_update**](docs/apis/AccountingApi.md#bills_update) | **PATCH** /accounting/bills/{id} | Update Bill | + +_AccountingApi_ | [**company_info_one**](docs/apis/AccountingApi.md#company_info_one) | **GET** /accounting/company-info | Get company info | + +_AccountingApi_ | [**credit_notes_add**](docs/apis/AccountingApi.md#credit_notes_add) | **POST** /accounting/credit-notes | Create Credit Note | + +_AccountingApi_ | [**credit_notes_all**](docs/apis/AccountingApi.md#credit_notes_all) | **GET** /accounting/credit-notes | List Credit Notes | + +_AccountingApi_ | [**credit_notes_delete**](docs/apis/AccountingApi.md#credit_notes_delete) | **DELETE** /accounting/credit-notes/{id} | Delete Credit Note | + +_AccountingApi_ | [**credit_notes_one**](docs/apis/AccountingApi.md#credit_notes_one) | **GET** /accounting/credit-notes/{id} | Get Credit Note | + +_AccountingApi_ | [**credit_notes_update**](docs/apis/AccountingApi.md#credit_notes_update) | **PATCH** /accounting/credit-notes/{id} | Update Credit Note | + +_AccountingApi_ | [**customers_add**](docs/apis/AccountingApi.md#customers_add) | **POST** /accounting/customers | Create Customer | + +_AccountingApi_ | [**customers_all**](docs/apis/AccountingApi.md#customers_all) | **GET** /accounting/customers | List Customers | + +_AccountingApi_ | [**customers_delete**](docs/apis/AccountingApi.md#customers_delete) | **DELETE** /accounting/customers/{id} | Delete Customer | + +_AccountingApi_ | [**customers_one**](docs/apis/AccountingApi.md#customers_one) | **GET** /accounting/customers/{id} | Get Customer | + +_AccountingApi_ | [**customers_update**](docs/apis/AccountingApi.md#customers_update) | **PATCH** /accounting/customers/{id} | Update Customer | + +_AccountingApi_ | [**invoice_items_add**](docs/apis/AccountingApi.md#invoice_items_add) | **POST** /accounting/invoice-items | Create Invoice Item | + +_AccountingApi_ | [**invoice_items_all**](docs/apis/AccountingApi.md#invoice_items_all) | **GET** /accounting/invoice-items | List Invoice Items | + +_AccountingApi_ | [**invoice_items_delete**](docs/apis/AccountingApi.md#invoice_items_delete) | **DELETE** /accounting/invoice-items/{id} | Delete Invoice Item | + +_AccountingApi_ | [**invoice_items_one**](docs/apis/AccountingApi.md#invoice_items_one) | **GET** /accounting/invoice-items/{id} | Get Invoice Item | + +_AccountingApi_ | [**invoice_items_update**](docs/apis/AccountingApi.md#invoice_items_update) | **PATCH** /accounting/invoice-items/{id} | Update Invoice Item | + +_AccountingApi_ | [**invoices_add**](docs/apis/AccountingApi.md#invoices_add) | **POST** /accounting/invoices | Create Invoice | + +_AccountingApi_ | [**invoices_all**](docs/apis/AccountingApi.md#invoices_all) | **GET** /accounting/invoices | List Invoices | + +_AccountingApi_ | [**invoices_delete**](docs/apis/AccountingApi.md#invoices_delete) | **DELETE** /accounting/invoices/{id} | Delete Invoice | + +_AccountingApi_ | [**invoices_one**](docs/apis/AccountingApi.md#invoices_one) | **GET** /accounting/invoices/{id} | Get Invoice | + +_AccountingApi_ | [**invoices_update**](docs/apis/AccountingApi.md#invoices_update) | **PATCH** /accounting/invoices/{id} | Update Invoice | + +_AccountingApi_ | [**ledger_accounts_add**](docs/apis/AccountingApi.md#ledger_accounts_add) | **POST** /accounting/ledger-accounts | Create Ledger Account | + +_AccountingApi_ | [**ledger_accounts_all**](docs/apis/AccountingApi.md#ledger_accounts_all) | **GET** /accounting/ledger-accounts | List Ledger Accounts | + +_AccountingApi_ | [**ledger_accounts_delete**](docs/apis/AccountingApi.md#ledger_accounts_delete) | **DELETE** /accounting/ledger-accounts/{id} | Delete Ledger Account | + +_AccountingApi_ | [**ledger_accounts_one**](docs/apis/AccountingApi.md#ledger_accounts_one) | **GET** /accounting/ledger-accounts/{id} | Get Ledger Account | + +_AccountingApi_ | [**ledger_accounts_update**](docs/apis/AccountingApi.md#ledger_accounts_update) | **PATCH** /accounting/ledger-accounts/{id} | Update Ledger Account | + +_AccountingApi_ | [**payments_add**](docs/apis/AccountingApi.md#payments_add) | **POST** /accounting/payments | Create Payment | + +_AccountingApi_ | [**payments_all**](docs/apis/AccountingApi.md#payments_all) | **GET** /accounting/payments | List Payments | + +_AccountingApi_ | [**payments_delete**](docs/apis/AccountingApi.md#payments_delete) | **DELETE** /accounting/payments/{id} | Delete Payment | + +_AccountingApi_ | [**payments_one**](docs/apis/AccountingApi.md#payments_one) | **GET** /accounting/payments/{id} | Get Payment | + +_AccountingApi_ | [**payments_update**](docs/apis/AccountingApi.md#payments_update) | **PATCH** /accounting/payments/{id} | Update Payment | + +_AccountingApi_ | [**profit_and_loss_one**](docs/apis/AccountingApi.md#profit_and_loss_one) | **GET** /accounting/profit-and-loss | Get Profit and Loss | + +_AccountingApi_ | [**suppliers_add**](docs/apis/AccountingApi.md#suppliers_add) | **POST** /accounting/suppliers | Create Supplier | + +_AccountingApi_ | [**suppliers_all**](docs/apis/AccountingApi.md#suppliers_all) | **GET** /accounting/suppliers | List Suppliers | + +_AccountingApi_ | [**suppliers_delete**](docs/apis/AccountingApi.md#suppliers_delete) | **DELETE** /accounting/suppliers/{id} | Delete Supplier | + +_AccountingApi_ | [**suppliers_one**](docs/apis/AccountingApi.md#suppliers_one) | **GET** /accounting/suppliers/{id} | Get Supplier | + +_AccountingApi_ | [**suppliers_update**](docs/apis/AccountingApi.md#suppliers_update) | **PATCH** /accounting/suppliers/{id} | Update Supplier | + +_AccountingApi_ | [**tax_rates_add**](docs/apis/AccountingApi.md#tax_rates_add) | **POST** /accounting/tax-rates | Create Tax Rate | + +_AccountingApi_ | [**tax_rates_all**](docs/apis/AccountingApi.md#tax_rates_all) | **GET** /accounting/tax-rates | List Tax Rates | + +_AccountingApi_ | [**tax_rates_delete**](docs/apis/AccountingApi.md#tax_rates_delete) | **DELETE** /accounting/tax-rates/{id} | Delete Tax Rate | + +_AccountingApi_ | [**tax_rates_one**](docs/apis/AccountingApi.md#tax_rates_one) | **GET** /accounting/tax-rates/{id} | Get Tax Rate | + +_AccountingApi_ | [**tax_rates_update**](docs/apis/AccountingApi.md#tax_rates_update) | **PATCH** /accounting/tax-rates/{id} | Update Tax Rate | + +_AtsApi_ | [**applicants_add**](docs/apis/AtsApi.md#applicants_add) | **POST** /ats/applicants | Create applicant | + +_AtsApi_ | [**applicants_all**](docs/apis/AtsApi.md#applicants_all) | **GET** /ats/applicants | List applicants | + +_AtsApi_ | [**applicants_one**](docs/apis/AtsApi.md#applicants_one) | **GET** /ats/applicants/{id} | Get applicant | + +_AtsApi_ | [**jobs_all**](docs/apis/AtsApi.md#jobs_all) | **GET** /ats/jobs | List Jobs | + +_AtsApi_ | [**jobs_one**](docs/apis/AtsApi.md#jobs_one) | **GET** /ats/jobs/{id} | Get Job | + +_ConnectorApi_ | [**api_resource_coverage_one**](docs/apis/ConnectorApi.md#api_resource_coverage_one) | **GET** /connector/apis/{id}/resources/{resource_id}/coverage | Get API Resource Coverage | + +_ConnectorApi_ | [**api_resources_one**](docs/apis/ConnectorApi.md#api_resources_one) | **GET** /connector/apis/{id}/resources/{resource_id} | Get API Resource | + +_ConnectorApi_ | [**apis_all**](docs/apis/ConnectorApi.md#apis_all) | **GET** /connector/apis | List APIs | + +_ConnectorApi_ | [**apis_one**](docs/apis/ConnectorApi.md#apis_one) | **GET** /connector/apis/{id} | Get API | + +_ConnectorApi_ | [**connector_docs_one**](docs/apis/ConnectorApi.md#connector_docs_one) | **GET** /connector/connectors/{id}/docs/{doc_id} | Get Connector Doc content | + +_ConnectorApi_ | [**connector_resources_one**](docs/apis/ConnectorApi.md#connector_resources_one) | **GET** /connector/connectors/{id}/resources/{resource_id} | Get Connector Resource | + +_ConnectorApi_ | [**connectors_all**](docs/apis/ConnectorApi.md#connectors_all) | **GET** /connector/connectors | List Connectors | + +_ConnectorApi_ | [**connectors_one**](docs/apis/ConnectorApi.md#connectors_one) | **GET** /connector/connectors/{id} | Get Connector | + +_CrmApi_ | [**activities_add**](docs/apis/CrmApi.md#activities_add) | **POST** /crm/activities | Create activity | + +_CrmApi_ | [**activities_all**](docs/apis/CrmApi.md#activities_all) | **GET** /crm/activities | List activities | + +_CrmApi_ | [**activities_delete**](docs/apis/CrmApi.md#activities_delete) | **DELETE** /crm/activities/{id} | Delete activity | + +_CrmApi_ | [**activities_one**](docs/apis/CrmApi.md#activities_one) | **GET** /crm/activities/{id} | Get activity | + +_CrmApi_ | [**activities_update**](docs/apis/CrmApi.md#activities_update) | **PATCH** /crm/activities/{id} | Update activity | + +_CrmApi_ | [**companies_add**](docs/apis/CrmApi.md#companies_add) | **POST** /crm/companies | Create company | + +_CrmApi_ | [**companies_all**](docs/apis/CrmApi.md#companies_all) | **GET** /crm/companies | List companies | + +_CrmApi_ | [**companies_delete**](docs/apis/CrmApi.md#companies_delete) | **DELETE** /crm/companies/{id} | Delete company | + +_CrmApi_ | [**companies_one**](docs/apis/CrmApi.md#companies_one) | **GET** /crm/companies/{id} | Get company | + +_CrmApi_ | [**companies_update**](docs/apis/CrmApi.md#companies_update) | **PATCH** /crm/companies/{id} | Update company | + +_CrmApi_ | [**contacts_add**](docs/apis/CrmApi.md#contacts_add) | **POST** /crm/contacts | Create contact | + +_CrmApi_ | [**contacts_all**](docs/apis/CrmApi.md#contacts_all) | **GET** /crm/contacts | List contacts | + +_CrmApi_ | [**contacts_delete**](docs/apis/CrmApi.md#contacts_delete) | **DELETE** /crm/contacts/{id} | Delete contact | + +_CrmApi_ | [**contacts_one**](docs/apis/CrmApi.md#contacts_one) | **GET** /crm/contacts/{id} | Get contact | + +_CrmApi_ | [**contacts_update**](docs/apis/CrmApi.md#contacts_update) | **PATCH** /crm/contacts/{id} | Update contact | + +_CrmApi_ | [**leads_add**](docs/apis/CrmApi.md#leads_add) | **POST** /crm/leads | Create lead | + +_CrmApi_ | [**leads_all**](docs/apis/CrmApi.md#leads_all) | **GET** /crm/leads | List leads | + +_CrmApi_ | [**leads_delete**](docs/apis/CrmApi.md#leads_delete) | **DELETE** /crm/leads/{id} | Delete lead | + +_CrmApi_ | [**leads_one**](docs/apis/CrmApi.md#leads_one) | **GET** /crm/leads/{id} | Get lead | + +_CrmApi_ | [**leads_update**](docs/apis/CrmApi.md#leads_update) | **PATCH** /crm/leads/{id} | Update lead | + +_CrmApi_ | [**notes_add**](docs/apis/CrmApi.md#notes_add) | **POST** /crm/notes | Create note | + +_CrmApi_ | [**notes_all**](docs/apis/CrmApi.md#notes_all) | **GET** /crm/notes | List notes | + +_CrmApi_ | [**notes_delete**](docs/apis/CrmApi.md#notes_delete) | **DELETE** /crm/notes/{id} | Delete note | + +_CrmApi_ | [**notes_one**](docs/apis/CrmApi.md#notes_one) | **GET** /crm/notes/{id} | Get note | + +_CrmApi_ | [**notes_update**](docs/apis/CrmApi.md#notes_update) | **PATCH** /crm/notes/{id} | Update note | + +_CrmApi_ | [**opportunities_add**](docs/apis/CrmApi.md#opportunities_add) | **POST** /crm/opportunities | Create opportunity | + +_CrmApi_ | [**opportunities_all**](docs/apis/CrmApi.md#opportunities_all) | **GET** /crm/opportunities | List opportunities | + +_CrmApi_ | [**opportunities_delete**](docs/apis/CrmApi.md#opportunities_delete) | **DELETE** /crm/opportunities/{id} | Delete opportunity | + +_CrmApi_ | [**opportunities_one**](docs/apis/CrmApi.md#opportunities_one) | **GET** /crm/opportunities/{id} | Get opportunity | + +_CrmApi_ | [**opportunities_update**](docs/apis/CrmApi.md#opportunities_update) | **PATCH** /crm/opportunities/{id} | Update opportunity | + +_CrmApi_ | [**pipelines_add**](docs/apis/CrmApi.md#pipelines_add) | **POST** /crm/pipelines | Create pipeline | + +_CrmApi_ | [**pipelines_all**](docs/apis/CrmApi.md#pipelines_all) | **GET** /crm/pipelines | List pipelines | + +_CrmApi_ | [**pipelines_delete**](docs/apis/CrmApi.md#pipelines_delete) | **DELETE** /crm/pipelines/{id} | Delete pipeline | + +_CrmApi_ | [**pipelines_one**](docs/apis/CrmApi.md#pipelines_one) | **GET** /crm/pipelines/{id} | Get pipeline | + +_CrmApi_ | [**pipelines_update**](docs/apis/CrmApi.md#pipelines_update) | **PATCH** /crm/pipelines/{id} | Update pipeline | + +_CrmApi_ | [**users_add**](docs/apis/CrmApi.md#users_add) | **POST** /crm/users | Create user | + +_CrmApi_ | [**users_all**](docs/apis/CrmApi.md#users_all) | **GET** /crm/users | List users | + +_CrmApi_ | [**users_delete**](docs/apis/CrmApi.md#users_delete) | **DELETE** /crm/users/{id} | Delete user | + +_CrmApi_ | [**users_one**](docs/apis/CrmApi.md#users_one) | **GET** /crm/users/{id} | Get user | + +_CrmApi_ | [**users_update**](docs/apis/CrmApi.md#users_update) | **PATCH** /crm/users/{id} | Update user | + +_CustomerSupportApi_ | [**customers_add**](docs/apis/CustomerSupportApi.md#customers_add) | **POST** /customer-support/customers | Create Customer Support Customer | + +_CustomerSupportApi_ | [**customers_all**](docs/apis/CustomerSupportApi.md#customers_all) | **GET** /customer-support/customers | List Customer Support Customers | + +_CustomerSupportApi_ | [**customers_delete**](docs/apis/CustomerSupportApi.md#customers_delete) | **DELETE** /customer-support/customers/{id} | Delete Customer Support Customer | + +_CustomerSupportApi_ | [**customers_one**](docs/apis/CustomerSupportApi.md#customers_one) | **GET** /customer-support/customers/{id} | Get Customer Support Customer | + +_CustomerSupportApi_ | [**customers_update**](docs/apis/CustomerSupportApi.md#customers_update) | **PATCH** /customer-support/customers/{id} | Update Customer Support Customer | + +_FileStorageApi_ | [**drive_groups_add**](docs/apis/FileStorageApi.md#drive_groups_add) | **POST** /file-storage/drive-groups | Create DriveGroup | + +_FileStorageApi_ | [**drive_groups_all**](docs/apis/FileStorageApi.md#drive_groups_all) | **GET** /file-storage/drive-groups | List DriveGroups | + +_FileStorageApi_ | [**drive_groups_delete**](docs/apis/FileStorageApi.md#drive_groups_delete) | **DELETE** /file-storage/drive-groups/{id} | Delete DriveGroup | + +_FileStorageApi_ | [**drive_groups_one**](docs/apis/FileStorageApi.md#drive_groups_one) | **GET** /file-storage/drive-groups/{id} | Get DriveGroup | + +_FileStorageApi_ | [**drive_groups_update**](docs/apis/FileStorageApi.md#drive_groups_update) | **PATCH** /file-storage/drive-groups/{id} | Update DriveGroup | + +_FileStorageApi_ | [**drives_add**](docs/apis/FileStorageApi.md#drives_add) | **POST** /file-storage/drives | Create Drive | + +_FileStorageApi_ | [**drives_all**](docs/apis/FileStorageApi.md#drives_all) | **GET** /file-storage/drives | List Drives | + +_FileStorageApi_ | [**drives_delete**](docs/apis/FileStorageApi.md#drives_delete) | **DELETE** /file-storage/drives/{id} | Delete Drive | + +_FileStorageApi_ | [**drives_one**](docs/apis/FileStorageApi.md#drives_one) | **GET** /file-storage/drives/{id} | Get Drive | + +_FileStorageApi_ | [**drives_update**](docs/apis/FileStorageApi.md#drives_update) | **PATCH** /file-storage/drives/{id} | Update Drive | + +_FileStorageApi_ | [**files_all**](docs/apis/FileStorageApi.md#files_all) | **GET** /file-storage/files | List Files | + +_FileStorageApi_ | [**files_delete**](docs/apis/FileStorageApi.md#files_delete) | **DELETE** /file-storage/files/{id} | Delete File | + +_FileStorageApi_ | [**files_download**](docs/apis/FileStorageApi.md#files_download) | **GET** /file-storage/files/{id}/download | Download File | + +_FileStorageApi_ | [**files_one**](docs/apis/FileStorageApi.md#files_one) | **GET** /file-storage/files/{id} | Get File | + +_FileStorageApi_ | [**files_search**](docs/apis/FileStorageApi.md#files_search) | **POST** /file-storage/files/search | Search Files | + +_FileStorageApi_ | [**folders_add**](docs/apis/FileStorageApi.md#folders_add) | **POST** /file-storage/folders | Create Folder | + +_FileStorageApi_ | [**folders_copy**](docs/apis/FileStorageApi.md#folders_copy) | **POST** /file-storage/folders/{id}/copy | Copy Folder | + +_FileStorageApi_ | [**folders_delete**](docs/apis/FileStorageApi.md#folders_delete) | **DELETE** /file-storage/folders/{id} | Delete Folder | + +_FileStorageApi_ | [**folders_one**](docs/apis/FileStorageApi.md#folders_one) | **GET** /file-storage/folders/{id} | Get Folder | + +_FileStorageApi_ | [**folders_update**](docs/apis/FileStorageApi.md#folders_update) | **PATCH** /file-storage/folders/{id} | Rename or move Folder | + +_FileStorageApi_ | [**shared_links_add**](docs/apis/FileStorageApi.md#shared_links_add) | **POST** /file-storage/shared-links | Create Shared Link | + +_FileStorageApi_ | [**shared_links_all**](docs/apis/FileStorageApi.md#shared_links_all) | **GET** /file-storage/shared-links | List SharedLinks | + +_FileStorageApi_ | [**shared_links_delete**](docs/apis/FileStorageApi.md#shared_links_delete) | **DELETE** /file-storage/shared-links/{id} | Delete Shared Link | + +_FileStorageApi_ | [**shared_links_one**](docs/apis/FileStorageApi.md#shared_links_one) | **GET** /file-storage/shared-links/{id} | Get Shared Link | + +_FileStorageApi_ | [**shared_links_update**](docs/apis/FileStorageApi.md#shared_links_update) | **PATCH** /file-storage/shared-links/{id} | Update Shared Link | + +_FileStorageApi_ | [**upload_sessions_add**](docs/apis/FileStorageApi.md#upload_sessions_add) | **POST** /file-storage/upload-sessions | Start Upload Session | + +_FileStorageApi_ | [**upload_sessions_delete**](docs/apis/FileStorageApi.md#upload_sessions_delete) | **DELETE** /file-storage/upload-sessions/{id} | Abort Upload Session | + +_FileStorageApi_ | [**upload_sessions_finish**](docs/apis/FileStorageApi.md#upload_sessions_finish) | **POST** /file-storage/upload-sessions/{id}/finish | Finish Upload Session | + +_FileStorageApi_ | [**upload_sessions_one**](docs/apis/FileStorageApi.md#upload_sessions_one) | **GET** /file-storage/upload-sessions/{id} | Get Upload Session | + +_HrisApi_ | [**companies_add**](docs/apis/HrisApi.md#companies_add) | **POST** /hris/companies | Create Company | + +_HrisApi_ | [**companies_all**](docs/apis/HrisApi.md#companies_all) | **GET** /hris/companies | List Companies | + +_HrisApi_ | [**companies_delete**](docs/apis/HrisApi.md#companies_delete) | **DELETE** /hris/companies/{id} | Delete Company | + +_HrisApi_ | [**companies_one**](docs/apis/HrisApi.md#companies_one) | **GET** /hris/companies/{id} | Get Company | + +_HrisApi_ | [**companies_update**](docs/apis/HrisApi.md#companies_update) | **PATCH** /hris/companies/{id} | Update Company | + +_HrisApi_ | [**departments_add**](docs/apis/HrisApi.md#departments_add) | **POST** /hris/departments | Create Department | + +_HrisApi_ | [**departments_all**](docs/apis/HrisApi.md#departments_all) | **GET** /hris/departments | List Departments | + +_HrisApi_ | [**departments_delete**](docs/apis/HrisApi.md#departments_delete) | **DELETE** /hris/departments/{id} | Delete Department | + +_HrisApi_ | [**departments_one**](docs/apis/HrisApi.md#departments_one) | **GET** /hris/departments/{id} | Get Department | + +_HrisApi_ | [**departments_update**](docs/apis/HrisApi.md#departments_update) | **PATCH** /hris/departments/{id} | Update Department | + +_HrisApi_ | [**employee_payrolls_all**](docs/apis/HrisApi.md#employee_payrolls_all) | **GET** /hris/payrolls/employees/{employee_id} | List Employee Payrolls | + +_HrisApi_ | [**employee_payrolls_one**](docs/apis/HrisApi.md#employee_payrolls_one) | **GET** /hris/payrolls/employees/{employee_id}/payrolls/{payroll_id} | Get Employee Payroll | + +_HrisApi_ | [**employee_schedules_all**](docs/apis/HrisApi.md#employee_schedules_all) | **GET** /hris/schedules/employees/{employee_id} | List Employee Schedules | + +_HrisApi_ | [**employees_add**](docs/apis/HrisApi.md#employees_add) | **POST** /hris/employees | Create Employee | + +_HrisApi_ | [**employees_all**](docs/apis/HrisApi.md#employees_all) | **GET** /hris/employees | List Employees | + +_HrisApi_ | [**employees_delete**](docs/apis/HrisApi.md#employees_delete) | **DELETE** /hris/employees/{id} | Delete Employee | + +_HrisApi_ | [**employees_one**](docs/apis/HrisApi.md#employees_one) | **GET** /hris/employees/{id} | Get Employee | + +_HrisApi_ | [**employees_update**](docs/apis/HrisApi.md#employees_update) | **PATCH** /hris/employees/{id} | Update Employee | + +_HrisApi_ | [**jobs_all**](docs/apis/HrisApi.md#jobs_all) | **GET** /hris/jobs/employees/{employee_id} | List Jobs | + +_HrisApi_ | [**jobs_one**](docs/apis/HrisApi.md#jobs_one) | **GET** /hris/jobs/employees/{employee_id}/jobs/{job_id} | One Job | + +_HrisApi_ | [**payrolls_all**](docs/apis/HrisApi.md#payrolls_all) | **GET** /hris/payrolls | List Payroll | + +_HrisApi_ | [**payrolls_one**](docs/apis/HrisApi.md#payrolls_one) | **GET** /hris/payrolls/{payroll_id} | Get Payroll | + +_HrisApi_ | [**time_off_requests_add**](docs/apis/HrisApi.md#time_off_requests_add) | **POST** /hris/time-off-requests | Create Time Off Request | + +_HrisApi_ | [**time_off_requests_all**](docs/apis/HrisApi.md#time_off_requests_all) | **GET** /hris/time-off-requests | List Time Off Requests | + +_HrisApi_ | [**time_off_requests_delete**](docs/apis/HrisApi.md#time_off_requests_delete) | **DELETE** /hris/time-off-requests/{id} | Delete Time Off Request | + +_HrisApi_ | [**time_off_requests_one**](docs/apis/HrisApi.md#time_off_requests_one) | **GET** /hris/time-off-requests/{id} | Get Time Off Request | + +_HrisApi_ | [**time_off_requests_update**](docs/apis/HrisApi.md#time_off_requests_update) | **PATCH** /hris/time-off-requests/{id} | Update Time Off Request | + +_LeadApi_ | [**leads_add**](docs/apis/LeadApi.md#leads_add) | **POST** /lead/leads | Create lead | + +_LeadApi_ | [**leads_all**](docs/apis/LeadApi.md#leads_all) | **GET** /lead/leads | List leads | + +_LeadApi_ | [**leads_delete**](docs/apis/LeadApi.md#leads_delete) | **DELETE** /lead/leads/{id} | Delete lead | + +_LeadApi_ | [**leads_one**](docs/apis/LeadApi.md#leads_one) | **GET** /lead/leads/{id} | Get lead | + +_LeadApi_ | [**leads_update**](docs/apis/LeadApi.md#leads_update) | **PATCH** /lead/leads/{id} | Update lead | + +_PosApi_ | [**items_add**](docs/apis/PosApi.md#items_add) | **POST** /pos/items | Create Item | + +_PosApi_ | [**items_all**](docs/apis/PosApi.md#items_all) | **GET** /pos/items | List Items | + +_PosApi_ | [**items_delete**](docs/apis/PosApi.md#items_delete) | **DELETE** /pos/items/{id} | Delete Item | + +_PosApi_ | [**items_one**](docs/apis/PosApi.md#items_one) | **GET** /pos/items/{id} | Get Item | + +_PosApi_ | [**items_update**](docs/apis/PosApi.md#items_update) | **PATCH** /pos/items/{id} | Update Item | + +_PosApi_ | [**locations_add**](docs/apis/PosApi.md#locations_add) | **POST** /pos/locations | Create Location | + +_PosApi_ | [**locations_all**](docs/apis/PosApi.md#locations_all) | **GET** /pos/locations | List Locations | + +_PosApi_ | [**locations_delete**](docs/apis/PosApi.md#locations_delete) | **DELETE** /pos/locations/{id} | Delete Location | + +_PosApi_ | [**locations_one**](docs/apis/PosApi.md#locations_one) | **GET** /pos/locations/{id} | Get Location | + +_PosApi_ | [**locations_update**](docs/apis/PosApi.md#locations_update) | **PATCH** /pos/locations/{id} | Update Location | + +_PosApi_ | [**merchants_add**](docs/apis/PosApi.md#merchants_add) | **POST** /pos/merchants | Create Merchant | + +_PosApi_ | [**merchants_all**](docs/apis/PosApi.md#merchants_all) | **GET** /pos/merchants | List Merchants | + +_PosApi_ | [**merchants_delete**](docs/apis/PosApi.md#merchants_delete) | **DELETE** /pos/merchants/{id} | Delete Merchant | + +_PosApi_ | [**merchants_one**](docs/apis/PosApi.md#merchants_one) | **GET** /pos/merchants/{id} | Get Merchant | + +_PosApi_ | [**merchants_update**](docs/apis/PosApi.md#merchants_update) | **PATCH** /pos/merchants/{id} | Update Merchant | + +_PosApi_ | [**modifier_groups_add**](docs/apis/PosApi.md#modifier_groups_add) | **POST** /pos/modifier-groups | Create Modifier Group | + +_PosApi_ | [**modifier_groups_all**](docs/apis/PosApi.md#modifier_groups_all) | **GET** /pos/modifier-groups | List Modifier Groups | + +_PosApi_ | [**modifier_groups_delete**](docs/apis/PosApi.md#modifier_groups_delete) | **DELETE** /pos/modifier-groups/{id} | Delete Modifier Group | + +_PosApi_ | [**modifier_groups_one**](docs/apis/PosApi.md#modifier_groups_one) | **GET** /pos/modifier-groups/{id} | Get Modifier Group | + +_PosApi_ | [**modifier_groups_update**](docs/apis/PosApi.md#modifier_groups_update) | **PATCH** /pos/modifier-groups/{id} | Update Modifier Group | + +_PosApi_ | [**modifiers_add**](docs/apis/PosApi.md#modifiers_add) | **POST** /pos/modifiers | Create Modifier | + +_PosApi_ | [**modifiers_all**](docs/apis/PosApi.md#modifiers_all) | **GET** /pos/modifiers | List Modifiers | + +_PosApi_ | [**modifiers_delete**](docs/apis/PosApi.md#modifiers_delete) | **DELETE** /pos/modifiers/{id} | Delete Modifier | + +_PosApi_ | [**modifiers_one**](docs/apis/PosApi.md#modifiers_one) | **GET** /pos/modifiers/{id} | Get Modifier | + +_PosApi_ | [**modifiers_update**](docs/apis/PosApi.md#modifiers_update) | **PATCH** /pos/modifiers/{id} | Update Modifier | + +_PosApi_ | [**order_types_add**](docs/apis/PosApi.md#order_types_add) | **POST** /pos/order-types | Create Order Type | + +_PosApi_ | [**order_types_all**](docs/apis/PosApi.md#order_types_all) | **GET** /pos/order-types | List Order Types | + +_PosApi_ | [**order_types_delete**](docs/apis/PosApi.md#order_types_delete) | **DELETE** /pos/order-types/{id} | Delete Order Type | + +_PosApi_ | [**order_types_one**](docs/apis/PosApi.md#order_types_one) | **GET** /pos/order-types/{id} | Get Order Type | + +_PosApi_ | [**order_types_update**](docs/apis/PosApi.md#order_types_update) | **PATCH** /pos/order-types/{id} | Update Order Type | + +_PosApi_ | [**orders_add**](docs/apis/PosApi.md#orders_add) | **POST** /pos/orders | Create Order | + +_PosApi_ | [**orders_all**](docs/apis/PosApi.md#orders_all) | **GET** /pos/orders | List Orders | + +_PosApi_ | [**orders_delete**](docs/apis/PosApi.md#orders_delete) | **DELETE** /pos/orders/{id} | Delete Order | + +_PosApi_ | [**orders_one**](docs/apis/PosApi.md#orders_one) | **GET** /pos/orders/{id} | Get Order | + +_PosApi_ | [**orders_pay**](docs/apis/PosApi.md#orders_pay) | **POST** /pos/orders/{id}/pay | Pay Order | + +_PosApi_ | [**orders_update**](docs/apis/PosApi.md#orders_update) | **PATCH** /pos/orders/{id} | Update Order | + +_PosApi_ | [**payments_add**](docs/apis/PosApi.md#payments_add) | **POST** /pos/payments | Create Payment | + +_PosApi_ | [**payments_all**](docs/apis/PosApi.md#payments_all) | **GET** /pos/payments | List Payments | + +_PosApi_ | [**payments_delete**](docs/apis/PosApi.md#payments_delete) | **DELETE** /pos/payments/{id} | Delete Payment | + +_PosApi_ | [**payments_one**](docs/apis/PosApi.md#payments_one) | **GET** /pos/payments/{id} | Get Payment | + +_PosApi_ | [**payments_update**](docs/apis/PosApi.md#payments_update) | **PATCH** /pos/payments/{id} | Update Payment | + +_PosApi_ | [**tenders_add**](docs/apis/PosApi.md#tenders_add) | **POST** /pos/tenders | Create Tender | + +_PosApi_ | [**tenders_all**](docs/apis/PosApi.md#tenders_all) | **GET** /pos/tenders | List Tenders | + +_PosApi_ | [**tenders_delete**](docs/apis/PosApi.md#tenders_delete) | **DELETE** /pos/tenders/{id} | Delete Tender | + +_PosApi_ | [**tenders_one**](docs/apis/PosApi.md#tenders_one) | **GET** /pos/tenders/{id} | Get Tender | + +_PosApi_ | [**tenders_update**](docs/apis/PosApi.md#tenders_update) | **PATCH** /pos/tenders/{id} | Update Tender | + +_SmsApi_ | [**messages_add**](docs/apis/SmsApi.md#messages_add) | **POST** /sms/messages | Create Message | + +_SmsApi_ | [**messages_all**](docs/apis/SmsApi.md#messages_all) | **GET** /sms/messages | List Messages | + +_SmsApi_ | [**messages_delete**](docs/apis/SmsApi.md#messages_delete) | **DELETE** /sms/messages/{id} | Delete Message | + +_SmsApi_ | [**messages_one**](docs/apis/SmsApi.md#messages_one) | **GET** /sms/messages/{id} | Get Message | + +_SmsApi_ | [**messages_update**](docs/apis/SmsApi.md#messages_update) | **PATCH** /sms/messages/{id} | Update Message | + +_VaultApi_ | [**connection_settings_all**](docs/apis/VaultApi.md#connection_settings_all) | **GET** /vault/connections/{unified_api}/{service_id}/{resource}/config | Get resource settings | + +_VaultApi_ | [**connection_settings_update**](docs/apis/VaultApi.md#connection_settings_update) | **PATCH** /vault/connections/{unified_api}/{service_id}/{resource}/config | Update settings | + +_VaultApi_ | [**connections_all**](docs/apis/VaultApi.md#connections_all) | **GET** /vault/connections | Get all connections | + +_VaultApi_ | [**connections_delete**](docs/apis/VaultApi.md#connections_delete) | **DELETE** /vault/connections/{unified_api}/{service_id} | Deletes a connection | + +_VaultApi_ | [**connections_import**](docs/apis/VaultApi.md#connections_import) | **POST** /vault/connections/{unified_api}/{service_id}/import | Import connection | + +_VaultApi_ | [**connections_one**](docs/apis/VaultApi.md#connections_one) | **GET** /vault/connections/{unified_api}/{service_id} | Get connection | + +_VaultApi_ | [**connections_update**](docs/apis/VaultApi.md#connections_update) | **PATCH** /vault/connections/{unified_api}/{service_id} | Update connection | + +_VaultApi_ | [**consumer_request_counts_all**](docs/apis/VaultApi.md#consumer_request_counts_all) | **GET** /vault/consumers/{consumer_id}/stats | Consumer request counts | + +_VaultApi_ | [**consumers_all**](docs/apis/VaultApi.md#consumers_all) | **GET** /vault/consumers | Get all consumers | + +_VaultApi_ | [**consumers_one**](docs/apis/VaultApi.md#consumers_one) | **GET** /vault/consumers/{consumer_id} | Get consumer | + +_VaultApi_ | [**logs_all**](docs/apis/VaultApi.md#logs_all) | **GET** /vault/logs | Get all consumer request logs | + +_VaultApi_ | [**sessions_create**](docs/apis/VaultApi.md#sessions_create) | **POST** /vault/sessions | Create Session | + +_WebhookApi_ | [**event_logs_all**](docs/apis/WebhookApi.md#event_logs_all) | **GET** /webhook/logs | List event logs | + +_WebhookApi_ | [**webhooks_add**](docs/apis/WebhookApi.md#webhooks_add) | **POST** /webhook/webhooks | Create webhook subscription | + +_WebhookApi_ | [**webhooks_all**](docs/apis/WebhookApi.md#webhooks_all) | **GET** /webhook/webhooks | List webhook subscriptions | + +_WebhookApi_ | [**webhooks_delete**](docs/apis/WebhookApi.md#webhooks_delete) | **DELETE** /webhook/webhooks/{id} | Delete webhook subscription | + +_WebhookApi_ | [**webhooks_one**](docs/apis/WebhookApi.md#webhooks_one) | **GET** /webhook/webhooks/{id} | Get webhook subscription | + +_WebhookApi_ | [**webhooks_update**](docs/apis/WebhookApi.md#webhooks_update) | **PATCH** /webhook/webhooks/{id} | Update webhook subscription | + + + +## Documentation For Models + + - [AccountingCustomer](docs/models/AccountingCustomer.md) + - [AccountingEventType](docs/models/AccountingEventType.md) + - [Activity](docs/models/Activity.md) + - [ActivityAttendee](docs/models/ActivityAttendee.md) + - [Address](docs/models/Address.md) + - [Api](docs/models/Api.md) + - [ApiResource](docs/models/ApiResource.md) + - [ApiResourceCoverage](docs/models/ApiResourceCoverage.md) + - [ApiResourceCoverageCoverage](docs/models/ApiResourceCoverageCoverage.md) + - [ApiResourceLinkedResources](docs/models/ApiResourceLinkedResources.md) + - [ApiResources](docs/models/ApiResources.md) + - [ApiStatus](docs/models/ApiStatus.md) + - [ApisFilter](docs/models/ApisFilter.md) + - [Applicant](docs/models/Applicant.md) + - [ApplicantSocialLinks](docs/models/ApplicantSocialLinks.md) + - [ApplicantWebsites](docs/models/ApplicantWebsites.md) + - [ApplicantsFilter](docs/models/ApplicantsFilter.md) + - [AtsActivity](docs/models/AtsActivity.md) + - [AtsEventType](docs/models/AtsEventType.md) + - [AuthType](docs/models/AuthType.md) + - [BadRequestResponse](docs/models/BadRequestResponse.md) + - [BalanceSheet](docs/models/BalanceSheet.md) + - [BalanceSheetAssets](docs/models/BalanceSheetAssets.md) + - [BalanceSheetAssetsCurrentAssets](docs/models/BalanceSheetAssetsCurrentAssets.md) + - [BalanceSheetAssetsCurrentAssetsAccounts](docs/models/BalanceSheetAssetsCurrentAssetsAccounts.md) + - [BalanceSheetAssetsFixedAssets](docs/models/BalanceSheetAssetsFixedAssets.md) + - [BalanceSheetAssetsFixedAssetsAccounts](docs/models/BalanceSheetAssetsFixedAssetsAccounts.md) + - [BalanceSheetEquity](docs/models/BalanceSheetEquity.md) + - [BalanceSheetEquityItems](docs/models/BalanceSheetEquityItems.md) + - [BalanceSheetFilter](docs/models/BalanceSheetFilter.md) + - [BalanceSheetLiabilities](docs/models/BalanceSheetLiabilities.md) + - [BalanceSheetLiabilitiesAccounts](docs/models/BalanceSheetLiabilitiesAccounts.md) + - [BankAccount](docs/models/BankAccount.md) + - [Benefit](docs/models/Benefit.md) + - [Bill](docs/models/Bill.md) + - [BillLineItem](docs/models/BillLineItem.md) + - [Branch](docs/models/Branch.md) + - [CashDetails](docs/models/CashDetails.md) + - [CompaniesFilter](docs/models/CompaniesFilter.md) + - [CompaniesSort](docs/models/CompaniesSort.md) + - [Company](docs/models/Company.md) + - [CompanyInfo](docs/models/CompanyInfo.md) + - [CompanyRowType](docs/models/CompanyRowType.md) + - [Compensation](docs/models/Compensation.md) + - [Connection](docs/models/Connection.md) + - [ConnectionConfiguration](docs/models/ConnectionConfiguration.md) + - [ConnectionDefaults](docs/models/ConnectionDefaults.md) + - [ConnectionImportData](docs/models/ConnectionImportData.md) + - [ConnectionImportDataCredentials](docs/models/ConnectionImportDataCredentials.md) + - [ConnectionMetadata](docs/models/ConnectionMetadata.md) + - [ConnectionState](docs/models/ConnectionState.md) + - [ConnectionWebhook](docs/models/ConnectionWebhook.md) + - [Connector](docs/models/Connector.md) + - [ConnectorDoc](docs/models/ConnectorDoc.md) + - [ConnectorEvent](docs/models/ConnectorEvent.md) + - [ConnectorOauthScopes](docs/models/ConnectorOauthScopes.md) + - [ConnectorOauthScopes1](docs/models/ConnectorOauthScopes1.md) + - [ConnectorResource](docs/models/ConnectorResource.md) + - [ConnectorSetting](docs/models/ConnectorSetting.md) + - [ConnectorStatus](docs/models/ConnectorStatus.md) + - [ConnectorTlsSupport](docs/models/ConnectorTlsSupport.md) + - [ConnectorUnifiedApis](docs/models/ConnectorUnifiedApis.md) + - [ConnectorsFilter](docs/models/ConnectorsFilter.md) + - [Consumer](docs/models/Consumer.md) + - [ConsumerConnection](docs/models/ConsumerConnection.md) + - [ConsumerMetadata](docs/models/ConsumerMetadata.md) + - [ConsumerRequestCountsInDateRangeResponse](docs/models/ConsumerRequestCountsInDateRangeResponse.md) + - [ConsumerRequestCountsInDateRangeResponseData](docs/models/ConsumerRequestCountsInDateRangeResponseData.md) + - [Contact](docs/models/Contact.md) + - [ContactsFilter](docs/models/ContactsFilter.md) + - [ContactsSort](docs/models/ContactsSort.md) + - [CopyFolderRequest](docs/models/CopyFolderRequest.md) + - [CreateActivityResponse](docs/models/CreateActivityResponse.md) + - [CreateApplicantResponse](docs/models/CreateApplicantResponse.md) + - [CreateBillResponse](docs/models/CreateBillResponse.md) + - [CreateCompanyResponse](docs/models/CreateCompanyResponse.md) + - [CreateConnectionResponse](docs/models/CreateConnectionResponse.md) + - [CreateContactResponse](docs/models/CreateContactResponse.md) + - [CreateCreditNoteResponse](docs/models/CreateCreditNoteResponse.md) + - [CreateCustomerResponse](docs/models/CreateCustomerResponse.md) + - [CreateCustomerSupportCustomerResponse](docs/models/CreateCustomerSupportCustomerResponse.md) + - [CreateDepartmentResponse](docs/models/CreateDepartmentResponse.md) + - [CreateDriveGroupResponse](docs/models/CreateDriveGroupResponse.md) + - [CreateDriveResponse](docs/models/CreateDriveResponse.md) + - [CreateEmployeeResponse](docs/models/CreateEmployeeResponse.md) + - [CreateFileRequest](docs/models/CreateFileRequest.md) + - [CreateFileResponse](docs/models/CreateFileResponse.md) + - [CreateFolderRequest](docs/models/CreateFolderRequest.md) + - [CreateFolderResponse](docs/models/CreateFolderResponse.md) + - [CreateHrisCompanyResponse](docs/models/CreateHrisCompanyResponse.md) + - [CreateInvoiceItemResponse](docs/models/CreateInvoiceItemResponse.md) + - [CreateInvoiceResponse](docs/models/CreateInvoiceResponse.md) + - [CreateItemResponse](docs/models/CreateItemResponse.md) + - [CreateJobResponse](docs/models/CreateJobResponse.md) + - [CreateLeadResponse](docs/models/CreateLeadResponse.md) + - [CreateLedgerAccountResponse](docs/models/CreateLedgerAccountResponse.md) + - [CreateLocationResponse](docs/models/CreateLocationResponse.md) + - [CreateMerchantResponse](docs/models/CreateMerchantResponse.md) + - [CreateMessageResponse](docs/models/CreateMessageResponse.md) + - [CreateModifierGroupResponse](docs/models/CreateModifierGroupResponse.md) + - [CreateModifierResponse](docs/models/CreateModifierResponse.md) + - [CreateNoteResponse](docs/models/CreateNoteResponse.md) + - [CreateOpportunityResponse](docs/models/CreateOpportunityResponse.md) + - [CreateOrderResponse](docs/models/CreateOrderResponse.md) + - [CreateOrderTypeResponse](docs/models/CreateOrderTypeResponse.md) + - [CreatePaymentResponse](docs/models/CreatePaymentResponse.md) + - [CreatePipelineResponse](docs/models/CreatePipelineResponse.md) + - [CreatePosPaymentResponse](docs/models/CreatePosPaymentResponse.md) + - [CreateSessionResponse](docs/models/CreateSessionResponse.md) + - [CreateSessionResponseData](docs/models/CreateSessionResponseData.md) + - [CreateSharedLinkResponse](docs/models/CreateSharedLinkResponse.md) + - [CreateSupplierResponse](docs/models/CreateSupplierResponse.md) + - [CreateTaxRateResponse](docs/models/CreateTaxRateResponse.md) + - [CreateTenderResponse](docs/models/CreateTenderResponse.md) + - [CreateTimeOffRequestResponse](docs/models/CreateTimeOffRequestResponse.md) + - [CreateUploadSessionRequest](docs/models/CreateUploadSessionRequest.md) + - [CreateUploadSessionResponse](docs/models/CreateUploadSessionResponse.md) + - [CreateUserResponse](docs/models/CreateUserResponse.md) + - [CreateWebhookRequest](docs/models/CreateWebhookRequest.md) + - [CreateWebhookResponse](docs/models/CreateWebhookResponse.md) + - [CreditNote](docs/models/CreditNote.md) + - [CrmEventType](docs/models/CrmEventType.md) + - [Currency](docs/models/Currency.md) + - [CustomField](docs/models/CustomField.md) + - [CustomerSupportCustomer](docs/models/CustomerSupportCustomer.md) + - [CustomersFilter](docs/models/CustomersFilter.md) + - [Deduction](docs/models/Deduction.md) + - [DeleteActivityResponse](docs/models/DeleteActivityResponse.md) + - [DeleteBillResponse](docs/models/DeleteBillResponse.md) + - [DeleteCompanyResponse](docs/models/DeleteCompanyResponse.md) + - [DeleteContactResponse](docs/models/DeleteContactResponse.md) + - [DeleteCreditNoteResponse](docs/models/DeleteCreditNoteResponse.md) + - [DeleteCustomerResponse](docs/models/DeleteCustomerResponse.md) + - [DeleteCustomerSupportCustomerResponse](docs/models/DeleteCustomerSupportCustomerResponse.md) + - [DeleteDepartmentResponse](docs/models/DeleteDepartmentResponse.md) + - [DeleteDriveGroupResponse](docs/models/DeleteDriveGroupResponse.md) + - [DeleteDriveResponse](docs/models/DeleteDriveResponse.md) + - [DeleteEmployeeResponse](docs/models/DeleteEmployeeResponse.md) + - [DeleteFileResponse](docs/models/DeleteFileResponse.md) + - [DeleteFolderResponse](docs/models/DeleteFolderResponse.md) + - [DeleteHrisCompanyResponse](docs/models/DeleteHrisCompanyResponse.md) + - [DeleteInvoiceItemResponse](docs/models/DeleteInvoiceItemResponse.md) + - [DeleteInvoiceResponse](docs/models/DeleteInvoiceResponse.md) + - [DeleteItemResponse](docs/models/DeleteItemResponse.md) + - [DeleteJobResponse](docs/models/DeleteJobResponse.md) + - [DeleteLeadResponse](docs/models/DeleteLeadResponse.md) + - [DeleteLedgerAccountResponse](docs/models/DeleteLedgerAccountResponse.md) + - [DeleteLocationResponse](docs/models/DeleteLocationResponse.md) + - [DeleteMerchantResponse](docs/models/DeleteMerchantResponse.md) + - [DeleteMessageResponse](docs/models/DeleteMessageResponse.md) + - [DeleteModifierGroupResponse](docs/models/DeleteModifierGroupResponse.md) + - [DeleteModifierResponse](docs/models/DeleteModifierResponse.md) + - [DeleteNoteResponse](docs/models/DeleteNoteResponse.md) + - [DeleteOpportunityResponse](docs/models/DeleteOpportunityResponse.md) + - [DeleteOrderResponse](docs/models/DeleteOrderResponse.md) + - [DeleteOrderTypeResponse](docs/models/DeleteOrderTypeResponse.md) + - [DeletePaymentResponse](docs/models/DeletePaymentResponse.md) + - [DeletePipelineResponse](docs/models/DeletePipelineResponse.md) + - [DeletePosPaymentResponse](docs/models/DeletePosPaymentResponse.md) + - [DeleteSharedLinkResponse](docs/models/DeleteSharedLinkResponse.md) + - [DeleteSupplierResponse](docs/models/DeleteSupplierResponse.md) + - [DeleteTaxRateResponse](docs/models/DeleteTaxRateResponse.md) + - [DeleteTenderResponse](docs/models/DeleteTenderResponse.md) + - [DeleteTimeOffRequestResponse](docs/models/DeleteTimeOffRequestResponse.md) + - [DeleteUploadSessionResponse](docs/models/DeleteUploadSessionResponse.md) + - [DeleteUserResponse](docs/models/DeleteUserResponse.md) + - [DeleteWebhookResponse](docs/models/DeleteWebhookResponse.md) + - [DeliveryUrl](docs/models/DeliveryUrl.md) + - [Department](docs/models/Department.md) + - [Drive](docs/models/Drive.md) + - [DriveGroup](docs/models/DriveGroup.md) + - [DriveGroupsFilter](docs/models/DriveGroupsFilter.md) + - [DrivesFilter](docs/models/DrivesFilter.md) + - [Email](docs/models/Email.md) + - [Employee](docs/models/Employee.md) + - [EmployeeCompensations](docs/models/EmployeeCompensations.md) + - [EmployeeEmploymentRole](docs/models/EmployeeEmploymentRole.md) + - [EmployeeJobs](docs/models/EmployeeJobs.md) + - [EmployeeManager](docs/models/EmployeeManager.md) + - [EmployeePartner](docs/models/EmployeePartner.md) + - [EmployeePayroll](docs/models/EmployeePayroll.md) + - [EmployeePayrolls](docs/models/EmployeePayrolls.md) + - [EmployeeSchedules](docs/models/EmployeeSchedules.md) + - [EmployeeTeam](docs/models/EmployeeTeam.md) + - [EmployeesFilter](docs/models/EmployeesFilter.md) + - [Error](docs/models/Error.md) + - [ExecuteBaseUrl](docs/models/ExecuteBaseUrl.md) + - [ExecuteWebhookEventRequest](docs/models/ExecuteWebhookEventRequest.md) + - [ExecuteWebhookEventsRequest](docs/models/ExecuteWebhookEventsRequest.md) + - [ExecuteWebhookResponse](docs/models/ExecuteWebhookResponse.md) + - [FileStorageEventType](docs/models/FileStorageEventType.md) + - [FileType](docs/models/FileType.md) + - [FilesFilter](docs/models/FilesFilter.md) + - [FilesSearch](docs/models/FilesSearch.md) + - [FilesSort](docs/models/FilesSort.md) + - [Folder](docs/models/Folder.md) + - [FormField](docs/models/FormField.md) + - [FormFieldOption](docs/models/FormFieldOption.md) + - [FormFieldOptionGroup](docs/models/FormFieldOptionGroup.md) + - [Gender](docs/models/Gender.md) + - [GetActivitiesResponse](docs/models/GetActivitiesResponse.md) + - [GetActivityResponse](docs/models/GetActivityResponse.md) + - [GetApiResourceCoverageResponse](docs/models/GetApiResourceCoverageResponse.md) + - [GetApiResourceResponse](docs/models/GetApiResourceResponse.md) + - [GetApiResponse](docs/models/GetApiResponse.md) + - [GetApisResponse](docs/models/GetApisResponse.md) + - [GetApplicantResponse](docs/models/GetApplicantResponse.md) + - [GetApplicantsResponse](docs/models/GetApplicantsResponse.md) + - [GetBalanceSheetResponse](docs/models/GetBalanceSheetResponse.md) + - [GetBillResponse](docs/models/GetBillResponse.md) + - [GetBillsResponse](docs/models/GetBillsResponse.md) + - [GetCompaniesResponse](docs/models/GetCompaniesResponse.md) + - [GetCompanyInfoResponse](docs/models/GetCompanyInfoResponse.md) + - [GetCompanyResponse](docs/models/GetCompanyResponse.md) + - [GetConnectionResponse](docs/models/GetConnectionResponse.md) + - [GetConnectionsResponse](docs/models/GetConnectionsResponse.md) + - [GetConnectorResourceResponse](docs/models/GetConnectorResourceResponse.md) + - [GetConnectorResponse](docs/models/GetConnectorResponse.md) + - [GetConnectorsResponse](docs/models/GetConnectorsResponse.md) + - [GetConsumerResponse](docs/models/GetConsumerResponse.md) + - [GetConsumersResponse](docs/models/GetConsumersResponse.md) + - [GetConsumersResponseData](docs/models/GetConsumersResponseData.md) + - [GetContactResponse](docs/models/GetContactResponse.md) + - [GetContactsResponse](docs/models/GetContactsResponse.md) + - [GetCreditNoteResponse](docs/models/GetCreditNoteResponse.md) + - [GetCreditNotesResponse](docs/models/GetCreditNotesResponse.md) + - [GetCustomerResponse](docs/models/GetCustomerResponse.md) + - [GetCustomerSupportCustomerResponse](docs/models/GetCustomerSupportCustomerResponse.md) + - [GetCustomerSupportCustomersResponse](docs/models/GetCustomerSupportCustomersResponse.md) + - [GetCustomersResponse](docs/models/GetCustomersResponse.md) + - [GetDepartmentResponse](docs/models/GetDepartmentResponse.md) + - [GetDepartmentsResponse](docs/models/GetDepartmentsResponse.md) + - [GetDriveGroupResponse](docs/models/GetDriveGroupResponse.md) + - [GetDriveGroupsResponse](docs/models/GetDriveGroupsResponse.md) + - [GetDriveResponse](docs/models/GetDriveResponse.md) + - [GetDrivesResponse](docs/models/GetDrivesResponse.md) + - [GetEmployeePayrollResponse](docs/models/GetEmployeePayrollResponse.md) + - [GetEmployeePayrollsResponse](docs/models/GetEmployeePayrollsResponse.md) + - [GetEmployeeResponse](docs/models/GetEmployeeResponse.md) + - [GetEmployeeSchedulesResponse](docs/models/GetEmployeeSchedulesResponse.md) + - [GetEmployeesResponse](docs/models/GetEmployeesResponse.md) + - [GetFileResponse](docs/models/GetFileResponse.md) + - [GetFilesResponse](docs/models/GetFilesResponse.md) + - [GetFolderResponse](docs/models/GetFolderResponse.md) + - [GetFoldersResponse](docs/models/GetFoldersResponse.md) + - [GetHrisCompaniesResponse](docs/models/GetHrisCompaniesResponse.md) + - [GetHrisCompanyResponse](docs/models/GetHrisCompanyResponse.md) + - [GetHrisJobResponse](docs/models/GetHrisJobResponse.md) + - [GetHrisJobsResponse](docs/models/GetHrisJobsResponse.md) + - [GetInvoiceItemResponse](docs/models/GetInvoiceItemResponse.md) + - [GetInvoiceItemsResponse](docs/models/GetInvoiceItemsResponse.md) + - [GetInvoiceResponse](docs/models/GetInvoiceResponse.md) + - [GetInvoicesResponse](docs/models/GetInvoicesResponse.md) + - [GetItemResponse](docs/models/GetItemResponse.md) + - [GetItemsResponse](docs/models/GetItemsResponse.md) + - [GetJobResponse](docs/models/GetJobResponse.md) + - [GetJobsResponse](docs/models/GetJobsResponse.md) + - [GetLeadResponse](docs/models/GetLeadResponse.md) + - [GetLeadsResponse](docs/models/GetLeadsResponse.md) + - [GetLedgerAccountResponse](docs/models/GetLedgerAccountResponse.md) + - [GetLedgerAccountsResponse](docs/models/GetLedgerAccountsResponse.md) + - [GetLocationResponse](docs/models/GetLocationResponse.md) + - [GetLocationsResponse](docs/models/GetLocationsResponse.md) + - [GetLogsResponse](docs/models/GetLogsResponse.md) + - [GetMerchantResponse](docs/models/GetMerchantResponse.md) + - [GetMerchantsResponse](docs/models/GetMerchantsResponse.md) + - [GetMessageResponse](docs/models/GetMessageResponse.md) + - [GetMessagesResponse](docs/models/GetMessagesResponse.md) + - [GetModifierGroupResponse](docs/models/GetModifierGroupResponse.md) + - [GetModifierGroupsResponse](docs/models/GetModifierGroupsResponse.md) + - [GetModifierResponse](docs/models/GetModifierResponse.md) + - [GetModifiersResponse](docs/models/GetModifiersResponse.md) + - [GetNoteResponse](docs/models/GetNoteResponse.md) + - [GetNotesResponse](docs/models/GetNotesResponse.md) + - [GetOpportunitiesResponse](docs/models/GetOpportunitiesResponse.md) + - [GetOpportunityResponse](docs/models/GetOpportunityResponse.md) + - [GetOrderResponse](docs/models/GetOrderResponse.md) + - [GetOrderTypeResponse](docs/models/GetOrderTypeResponse.md) + - [GetOrderTypesResponse](docs/models/GetOrderTypesResponse.md) + - [GetOrdersResponse](docs/models/GetOrdersResponse.md) + - [GetPaymentResponse](docs/models/GetPaymentResponse.md) + - [GetPaymentsResponse](docs/models/GetPaymentsResponse.md) + - [GetPayrollResponse](docs/models/GetPayrollResponse.md) + - [GetPayrollsResponse](docs/models/GetPayrollsResponse.md) + - [GetPipelineResponse](docs/models/GetPipelineResponse.md) + - [GetPipelinesResponse](docs/models/GetPipelinesResponse.md) + - [GetPosPaymentResponse](docs/models/GetPosPaymentResponse.md) + - [GetPosPaymentsResponse](docs/models/GetPosPaymentsResponse.md) + - [GetProfitAndLossResponse](docs/models/GetProfitAndLossResponse.md) + - [GetSharedLinkResponse](docs/models/GetSharedLinkResponse.md) + - [GetSharedLinksResponse](docs/models/GetSharedLinksResponse.md) + - [GetSupplierResponse](docs/models/GetSupplierResponse.md) + - [GetSuppliersResponse](docs/models/GetSuppliersResponse.md) + - [GetTaxRateResponse](docs/models/GetTaxRateResponse.md) + - [GetTaxRatesResponse](docs/models/GetTaxRatesResponse.md) + - [GetTenderResponse](docs/models/GetTenderResponse.md) + - [GetTendersResponse](docs/models/GetTendersResponse.md) + - [GetTimeOffRequestResponse](docs/models/GetTimeOffRequestResponse.md) + - [GetTimeOffRequestsResponse](docs/models/GetTimeOffRequestsResponse.md) + - [GetUploadSessionResponse](docs/models/GetUploadSessionResponse.md) + - [GetUserResponse](docs/models/GetUserResponse.md) + - [GetUsersResponse](docs/models/GetUsersResponse.md) + - [GetWebhookEventLogsResponse](docs/models/GetWebhookEventLogsResponse.md) + - [GetWebhookResponse](docs/models/GetWebhookResponse.md) + - [GetWebhooksResponse](docs/models/GetWebhooksResponse.md) + - [HrisCompany](docs/models/HrisCompany.md) + - [HrisEventType](docs/models/HrisEventType.md) + - [HrisJob](docs/models/HrisJob.md) + - [HrisJobLocation](docs/models/HrisJobLocation.md) + - [HrisJobs](docs/models/HrisJobs.md) + - [IdempotencyKey](docs/models/IdempotencyKey.md) + - [Invoice](docs/models/Invoice.md) + - [InvoiceItem](docs/models/InvoiceItem.md) + - [InvoiceItemAssetAccount](docs/models/InvoiceItemAssetAccount.md) + - [InvoiceItemExpenseAccount](docs/models/InvoiceItemExpenseAccount.md) + - [InvoiceItemIncomeAccount](docs/models/InvoiceItemIncomeAccount.md) + - [InvoiceItemSalesDetails](docs/models/InvoiceItemSalesDetails.md) + - [InvoiceItemsFilter](docs/models/InvoiceItemsFilter.md) + - [InvoiceLineItem](docs/models/InvoiceLineItem.md) + - [InvoiceResponse](docs/models/InvoiceResponse.md) + - [InvoicesSort](docs/models/InvoicesSort.md) + - [Item](docs/models/Item.md) + - [Job](docs/models/Job.md) + - [JobSalary](docs/models/JobSalary.md) + - [JobStatus](docs/models/JobStatus.md) + - [JobsFilter](docs/models/JobsFilter.md) + - [Lead](docs/models/Lead.md) + - [LeadEventType](docs/models/LeadEventType.md) + - [LeadsFilter](docs/models/LeadsFilter.md) + - [LeadsSort](docs/models/LeadsSort.md) + - [LedgerAccount](docs/models/LedgerAccount.md) + - [LedgerAccountCategories](docs/models/LedgerAccountCategories.md) + - [LedgerAccountParentAccount](docs/models/LedgerAccountParentAccount.md) + - [LedgerAccounts](docs/models/LedgerAccounts.md) + - [LinkedConnectorResource](docs/models/LinkedConnectorResource.md) + - [LinkedCustomer](docs/models/LinkedCustomer.md) + - [LinkedFolder](docs/models/LinkedFolder.md) + - [LinkedInvoiceItem](docs/models/LinkedInvoiceItem.md) + - [LinkedLedgerAccount](docs/models/LinkedLedgerAccount.md) + - [LinkedSupplier](docs/models/LinkedSupplier.md) + - [LinkedTaxRate](docs/models/LinkedTaxRate.md) + - [Links](docs/models/Links.md) + - [Location](docs/models/Location.md) + - [Log](docs/models/Log.md) + - [LogOperation](docs/models/LogOperation.md) + - [LogService](docs/models/LogService.md) + - [LogsFilter](docs/models/LogsFilter.md) + - [Merchant](docs/models/Merchant.md) + - [Message](docs/models/Message.md) + - [Meta](docs/models/Meta.md) + - [MetaCursors](docs/models/MetaCursors.md) + - [Modifier](docs/models/Modifier.md) + - [ModifierGroup](docs/models/ModifierGroup.md) + - [ModifierGroupFilter](docs/models/ModifierGroupFilter.md) + - [NotFoundResponse](docs/models/NotFoundResponse.md) + - [NotImplementedResponse](docs/models/NotImplementedResponse.md) + - [Note](docs/models/Note.md) + - [OAuthGrantType](docs/models/OAuthGrantType.md) + - [Offer](docs/models/Offer.md) + - [OpportunitiesFilter](docs/models/OpportunitiesFilter.md) + - [OpportunitiesSort](docs/models/OpportunitiesSort.md) + - [Opportunity](docs/models/Opportunity.md) + - [Order](docs/models/Order.md) + - [OrderCustomers](docs/models/OrderCustomers.md) + - [OrderDiscounts](docs/models/OrderDiscounts.md) + - [OrderFulfillments](docs/models/OrderFulfillments.md) + - [OrderLineItems](docs/models/OrderLineItems.md) + - [OrderPayments](docs/models/OrderPayments.md) + - [OrderPickupDetails](docs/models/OrderPickupDetails.md) + - [OrderPickupDetailsCurbsidePickupDetails](docs/models/OrderPickupDetailsCurbsidePickupDetails.md) + - [OrderPickupDetailsRecipient](docs/models/OrderPickupDetailsRecipient.md) + - [OrderRefunds](docs/models/OrderRefunds.md) + - [OrderTenders](docs/models/OrderTenders.md) + - [OrderType](docs/models/OrderType.md) + - [Owner](docs/models/Owner.md) + - [PaginationCoverage](docs/models/PaginationCoverage.md) + - [Passthrough](docs/models/Passthrough.md) + - [Payment](docs/models/Payment.md) + - [PaymentAllocations](docs/models/PaymentAllocations.md) + - [PaymentCard](docs/models/PaymentCard.md) + - [PaymentRequiredResponse](docs/models/PaymentRequiredResponse.md) + - [PaymentUnit](docs/models/PaymentUnit.md) + - [Payroll](docs/models/Payroll.md) + - [PayrollTotals](docs/models/PayrollTotals.md) + - [PayrollsFilter](docs/models/PayrollsFilter.md) + - [PhoneNumber](docs/models/PhoneNumber.md) + - [Pipeline](docs/models/Pipeline.md) + - [PipelineStages](docs/models/PipelineStages.md) + - [PosBankAccount](docs/models/PosBankAccount.md) + - [PosBankAccountAchDetails](docs/models/PosBankAccountAchDetails.md) + - [PosPayment](docs/models/PosPayment.md) + - [PosPaymentCardDetails](docs/models/PosPaymentCardDetails.md) + - [PosPaymentExternalDetails](docs/models/PosPaymentExternalDetails.md) + - [Price](docs/models/Price.md) + - [ProfitAndLoss](docs/models/ProfitAndLoss.md) + - [ProfitAndLossExpenses](docs/models/ProfitAndLossExpenses.md) + - [ProfitAndLossFilter](docs/models/ProfitAndLossFilter.md) + - [ProfitAndLossGrossProfit](docs/models/ProfitAndLossGrossProfit.md) + - [ProfitAndLossIncome](docs/models/ProfitAndLossIncome.md) + - [ProfitAndLossNetIncome](docs/models/ProfitAndLossNetIncome.md) + - [ProfitAndLossNetOperatingIncome](docs/models/ProfitAndLossNetOperatingIncome.md) + - [ProfitAndLossRecord](docs/models/ProfitAndLossRecord.md) + - [ProfitAndLossRecords](docs/models/ProfitAndLossRecords.md) + - [ProfitAndLossSection](docs/models/ProfitAndLossSection.md) + - [RequestCountAllocation](docs/models/RequestCountAllocation.md) + - [ResolveWebhookEventRequest](docs/models/ResolveWebhookEventRequest.md) + - [ResolveWebhookEventsRequest](docs/models/ResolveWebhookEventsRequest.md) + - [ResolveWebhookResponse](docs/models/ResolveWebhookResponse.md) + - [ResourceStatus](docs/models/ResourceStatus.md) + - [Schedule](docs/models/Schedule.md) + - [ScheduleWorkPattern](docs/models/ScheduleWorkPattern.md) + - [ScheduleWorkPatternOddWeeks](docs/models/ScheduleWorkPatternOddWeeks.md) + - [ServiceCharge](docs/models/ServiceCharge.md) + - [ServiceCharges](docs/models/ServiceCharges.md) + - [Session](docs/models/Session.md) + - [SessionSettings](docs/models/SessionSettings.md) + - [SessionTheme](docs/models/SessionTheme.md) + - [SharedLink](docs/models/SharedLink.md) + - [SharedLinkTarget](docs/models/SharedLinkTarget.md) + - [SimpleFormFieldOption](docs/models/SimpleFormFieldOption.md) + - [SocialLink](docs/models/SocialLink.md) + - [SortDirection](docs/models/SortDirection.md) + - [Status](docs/models/Status.md) + - [Supplier](docs/models/Supplier.md) + - [SupportedProperty](docs/models/SupportedProperty.md) + - [SupportedPropertyChildProperties](docs/models/SupportedPropertyChildProperties.md) + - [Tags](docs/models/Tags.md) + - [Tax](docs/models/Tax.md) + - [TaxRate](docs/models/TaxRate.md) + - [TaxRatesFilter](docs/models/TaxRatesFilter.md) + - [Tender](docs/models/Tender.md) + - [TimeOffRequest](docs/models/TimeOffRequest.md) + - [TimeOffRequestNotes](docs/models/TimeOffRequestNotes.md) + - [TimeOffRequestsFilter](docs/models/TimeOffRequestsFilter.md) + - [TooManyRequestsResponse](docs/models/TooManyRequestsResponse.md) + - [TooManyRequestsResponseDetail](docs/models/TooManyRequestsResponseDetail.md) + - [UnauthorizedResponse](docs/models/UnauthorizedResponse.md) + - [UnexpectedErrorResponse](docs/models/UnexpectedErrorResponse.md) + - [UnifiedApiId](docs/models/UnifiedApiId.md) + - [UnifiedFile](docs/models/UnifiedFile.md) + - [UnifiedId](docs/models/UnifiedId.md) + - [UnprocessableResponse](docs/models/UnprocessableResponse.md) + - [UpdateActivityResponse](docs/models/UpdateActivityResponse.md) + - [UpdateBillResponse](docs/models/UpdateBillResponse.md) + - [UpdateCompanyResponse](docs/models/UpdateCompanyResponse.md) + - [UpdateConnectionResponse](docs/models/UpdateConnectionResponse.md) + - [UpdateContactResponse](docs/models/UpdateContactResponse.md) + - [UpdateCreditNoteResponse](docs/models/UpdateCreditNoteResponse.md) + - [UpdateCustomerResponse](docs/models/UpdateCustomerResponse.md) + - [UpdateCustomerSupportCustomerResponse](docs/models/UpdateCustomerSupportCustomerResponse.md) + - [UpdateDepartmentResponse](docs/models/UpdateDepartmentResponse.md) + - [UpdateDriveGroupResponse](docs/models/UpdateDriveGroupResponse.md) + - [UpdateDriveResponse](docs/models/UpdateDriveResponse.md) + - [UpdateEmployeeResponse](docs/models/UpdateEmployeeResponse.md) + - [UpdateFileResponse](docs/models/UpdateFileResponse.md) + - [UpdateFolderRequest](docs/models/UpdateFolderRequest.md) + - [UpdateFolderResponse](docs/models/UpdateFolderResponse.md) + - [UpdateHrisCompanyResponse](docs/models/UpdateHrisCompanyResponse.md) + - [UpdateInvoiceItemsResponse](docs/models/UpdateInvoiceItemsResponse.md) + - [UpdateInvoiceResponse](docs/models/UpdateInvoiceResponse.md) + - [UpdateItemResponse](docs/models/UpdateItemResponse.md) + - [UpdateJobResponse](docs/models/UpdateJobResponse.md) + - [UpdateLeadResponse](docs/models/UpdateLeadResponse.md) + - [UpdateLedgerAccountResponse](docs/models/UpdateLedgerAccountResponse.md) + - [UpdateLocationResponse](docs/models/UpdateLocationResponse.md) + - [UpdateMerchantResponse](docs/models/UpdateMerchantResponse.md) + - [UpdateMessageResponse](docs/models/UpdateMessageResponse.md) + - [UpdateModifierGroupResponse](docs/models/UpdateModifierGroupResponse.md) + - [UpdateModifierResponse](docs/models/UpdateModifierResponse.md) + - [UpdateNoteResponse](docs/models/UpdateNoteResponse.md) + - [UpdateOpportunityResponse](docs/models/UpdateOpportunityResponse.md) + - [UpdateOrderResponse](docs/models/UpdateOrderResponse.md) + - [UpdateOrderTypeResponse](docs/models/UpdateOrderTypeResponse.md) + - [UpdatePaymentResponse](docs/models/UpdatePaymentResponse.md) + - [UpdatePipelineResponse](docs/models/UpdatePipelineResponse.md) + - [UpdatePosPaymentResponse](docs/models/UpdatePosPaymentResponse.md) + - [UpdateSharedLinkResponse](docs/models/UpdateSharedLinkResponse.md) + - [UpdateSupplierResponse](docs/models/UpdateSupplierResponse.md) + - [UpdateTaxRateResponse](docs/models/UpdateTaxRateResponse.md) + - [UpdateTenderResponse](docs/models/UpdateTenderResponse.md) + - [UpdateTimeOffRequestResponse](docs/models/UpdateTimeOffRequestResponse.md) + - [UpdateUploadSessionResponse](docs/models/UpdateUploadSessionResponse.md) + - [UpdateUserResponse](docs/models/UpdateUserResponse.md) + - [UpdateWebhookRequest](docs/models/UpdateWebhookRequest.md) + - [UpdateWebhookResponse](docs/models/UpdateWebhookResponse.md) + - [UploadSession](docs/models/UploadSession.md) + - [Url](docs/models/Url.md) + - [User](docs/models/User.md) + - [VaultEventType](docs/models/VaultEventType.md) + - [WalletDetails](docs/models/WalletDetails.md) + - [Webhook](docs/models/Webhook.md) + - [WebhookEventLog](docs/models/WebhookEventLog.md) + - [WebhookEventLogAttempts](docs/models/WebhookEventLogAttempts.md) + - [WebhookEventLogService](docs/models/WebhookEventLogService.md) + - [WebhookEventLogsFilter](docs/models/WebhookEventLogsFilter.md) + - [WebhookEventLogsFilterService](docs/models/WebhookEventLogsFilterService.md) + - [WebhookEventType](docs/models/WebhookEventType.md) + - [WebhookSubscription](docs/models/WebhookSubscription.md) + - [WebhookSupport](docs/models/WebhookSupport.md) + - [Website](docs/models/Website.md) + + +## Documentation For Authorization + + + +## apiKey + + +- **Type**: API key +- **API key parameter name**: Authorization +- **Location**: HTTP header + + + +## applicationId + + +- **Type**: API key +- **API key parameter name**: x-apideck-app-id +- **Location**: HTTP header + + + +## consumerId + + +- **Type**: API key +- **API key parameter name**: x-apideck-consumer-id +- **Location**: HTTP header + + +## Author + + + + +## Notes for Large OpenAPI documents + +If the OpenAPI document is large, imports in apideck.apis and apideck.models may fail with a +RecursionError indicating the maximum recursion limit has been exceeded. In that case, there are a couple of solutions: + +Solution 1: +Use specific imports for apis and models like: + +- `from apideck.api.default_api import DefaultApi` +- `from apideck.model.pet import Pet` + +Solution 2: +Before importing the package, adjust the maximum recursion limit as shown below: + +``` +import sys +sys.setrecursionlimit(1500) +import apideck +from apideck.apis import * +from apideck.models import * +``` + diff --git a/docs/apis/AccountingApi.md b/docs/apis/AccountingApi.md new file mode 100644 index 0000000000..87603818e1 --- /dev/null +++ b/docs/apis/AccountingApi.md @@ -0,0 +1,6271 @@ +# apideck.AccountingApi + +All URIs are relative to *https://unify.apideck.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**balance_sheet_one**](AccountingApi.md#balance_sheet_one) | **GET** /accounting/balance-sheet | Get BalanceSheet +[**bills_add**](AccountingApi.md#bills_add) | **POST** /accounting/bills | Create Bill +[**bills_all**](AccountingApi.md#bills_all) | **GET** /accounting/bills | List Bills +[**bills_delete**](AccountingApi.md#bills_delete) | **DELETE** /accounting/bills/{id} | Delete Bill +[**bills_one**](AccountingApi.md#bills_one) | **GET** /accounting/bills/{id} | Get Bill +[**bills_update**](AccountingApi.md#bills_update) | **PATCH** /accounting/bills/{id} | Update Bill +[**company_info_one**](AccountingApi.md#company_info_one) | **GET** /accounting/company-info | Get company info +[**credit_notes_add**](AccountingApi.md#credit_notes_add) | **POST** /accounting/credit-notes | Create Credit Note +[**credit_notes_all**](AccountingApi.md#credit_notes_all) | **GET** /accounting/credit-notes | List Credit Notes +[**credit_notes_delete**](AccountingApi.md#credit_notes_delete) | **DELETE** /accounting/credit-notes/{id} | Delete Credit Note +[**credit_notes_one**](AccountingApi.md#credit_notes_one) | **GET** /accounting/credit-notes/{id} | Get Credit Note +[**credit_notes_update**](AccountingApi.md#credit_notes_update) | **PATCH** /accounting/credit-notes/{id} | Update Credit Note +[**customers_add**](AccountingApi.md#customers_add) | **POST** /accounting/customers | Create Customer +[**customers_all**](AccountingApi.md#customers_all) | **GET** /accounting/customers | List Customers +[**customers_delete**](AccountingApi.md#customers_delete) | **DELETE** /accounting/customers/{id} | Delete Customer +[**customers_one**](AccountingApi.md#customers_one) | **GET** /accounting/customers/{id} | Get Customer +[**customers_update**](AccountingApi.md#customers_update) | **PATCH** /accounting/customers/{id} | Update Customer +[**invoice_items_add**](AccountingApi.md#invoice_items_add) | **POST** /accounting/invoice-items | Create Invoice Item +[**invoice_items_all**](AccountingApi.md#invoice_items_all) | **GET** /accounting/invoice-items | List Invoice Items +[**invoice_items_delete**](AccountingApi.md#invoice_items_delete) | **DELETE** /accounting/invoice-items/{id} | Delete Invoice Item +[**invoice_items_one**](AccountingApi.md#invoice_items_one) | **GET** /accounting/invoice-items/{id} | Get Invoice Item +[**invoice_items_update**](AccountingApi.md#invoice_items_update) | **PATCH** /accounting/invoice-items/{id} | Update Invoice Item +[**invoices_add**](AccountingApi.md#invoices_add) | **POST** /accounting/invoices | Create Invoice +[**invoices_all**](AccountingApi.md#invoices_all) | **GET** /accounting/invoices | List Invoices +[**invoices_delete**](AccountingApi.md#invoices_delete) | **DELETE** /accounting/invoices/{id} | Delete Invoice +[**invoices_one**](AccountingApi.md#invoices_one) | **GET** /accounting/invoices/{id} | Get Invoice +[**invoices_update**](AccountingApi.md#invoices_update) | **PATCH** /accounting/invoices/{id} | Update Invoice +[**ledger_accounts_add**](AccountingApi.md#ledger_accounts_add) | **POST** /accounting/ledger-accounts | Create Ledger Account +[**ledger_accounts_all**](AccountingApi.md#ledger_accounts_all) | **GET** /accounting/ledger-accounts | List Ledger Accounts +[**ledger_accounts_delete**](AccountingApi.md#ledger_accounts_delete) | **DELETE** /accounting/ledger-accounts/{id} | Delete Ledger Account +[**ledger_accounts_one**](AccountingApi.md#ledger_accounts_one) | **GET** /accounting/ledger-accounts/{id} | Get Ledger Account +[**ledger_accounts_update**](AccountingApi.md#ledger_accounts_update) | **PATCH** /accounting/ledger-accounts/{id} | Update Ledger Account +[**payments_add**](AccountingApi.md#payments_add) | **POST** /accounting/payments | Create Payment +[**payments_all**](AccountingApi.md#payments_all) | **GET** /accounting/payments | List Payments +[**payments_delete**](AccountingApi.md#payments_delete) | **DELETE** /accounting/payments/{id} | Delete Payment +[**payments_one**](AccountingApi.md#payments_one) | **GET** /accounting/payments/{id} | Get Payment +[**payments_update**](AccountingApi.md#payments_update) | **PATCH** /accounting/payments/{id} | Update Payment +[**profit_and_loss_one**](AccountingApi.md#profit_and_loss_one) | **GET** /accounting/profit-and-loss | Get Profit and Loss +[**suppliers_add**](AccountingApi.md#suppliers_add) | **POST** /accounting/suppliers | Create Supplier +[**suppliers_all**](AccountingApi.md#suppliers_all) | **GET** /accounting/suppliers | List Suppliers +[**suppliers_delete**](AccountingApi.md#suppliers_delete) | **DELETE** /accounting/suppliers/{id} | Delete Supplier +[**suppliers_one**](AccountingApi.md#suppliers_one) | **GET** /accounting/suppliers/{id} | Get Supplier +[**suppliers_update**](AccountingApi.md#suppliers_update) | **PATCH** /accounting/suppliers/{id} | Update Supplier +[**tax_rates_add**](AccountingApi.md#tax_rates_add) | **POST** /accounting/tax-rates | Create Tax Rate +[**tax_rates_all**](AccountingApi.md#tax_rates_all) | **GET** /accounting/tax-rates | List Tax Rates +[**tax_rates_delete**](AccountingApi.md#tax_rates_delete) | **DELETE** /accounting/tax-rates/{id} | Delete Tax Rate +[**tax_rates_one**](AccountingApi.md#tax_rates_one) | **GET** /accounting/tax-rates/{id} | Get Tax Rate +[**tax_rates_update**](AccountingApi.md#tax_rates_update) | **PATCH** /accounting/tax-rates/{id} | Update Tax Rate + + +# **balance_sheet_one** +> GetBalanceSheetResponse balance_sheet_one() + +Get BalanceSheet + +Get BalanceSheet + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import accounting_api +from apideck.model.balance_sheet_filter import BalanceSheetFilter +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.get_balance_sheet_response import GetBalanceSheetResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.passthrough import Passthrough +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = accounting_api.AccountingApi(api_client) + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + pass_through = Passthrough() # Passthrough | Optional unmapped key/values that will be passed through to downstream as query parameters (optional) + filter = BalanceSheetFilter( + start_date="2021-01-01", + end_date="2021-12-31", + ) # BalanceSheetFilter | Apply filters (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get BalanceSheet + api_response = api_instance.balance_sheet_one(consumer_id=consumer_id, app_id=app_id, service_id=service_id, pass_through=pass_through, filter=filter, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling AccountingApi->balance_sheet_one: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **pass_through** | **Passthrough**| Optional unmapped key/values that will be passed through to downstream as query parameters | [optional] + **filter** | **BalanceSheetFilter**| Apply filters | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + +### Return type + +[**GetBalanceSheetResponse**](GetBalanceSheetResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | BalanceSheet | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **bills_add** +> CreateBillResponse bills_add(bill) + +Create Bill + +Create Bill + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import accounting_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.bill import Bill +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.create_bill_response import CreateBillResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = accounting_api.AccountingApi(api_client) + bill = Bill( + supplier=LinkedSupplier( + id="12345", + display_name="Windsurf Shop", + address=Address( + id="123", + type="primary", + string="25 Spring Street, Blackburn, VIC 3130", + name="HQ US", + line1="Main street", + line2="apt #", + line3="Suite #", + line4="delivery instructions", + street_number="25", + city="San Francisco", + state="CA", + postal_code="94104", + country="US", + latitude="40.759211", + longitude="-73.984638", + county="Santa Clara", + contact_name="Elon Musk", + salutation="Mr", + phone_number="111-111-1111", + fax="122-111-1111", + email="elon@musk.com", + website="https://elonmusk.com", + row_version="1-12345", + ), + ), + currency=Currency("USD"), + currency_rate=0.69, + tax_inclusive=True, + bill_date=dateutil_parser('Wed Sep 30 02:00:00 CEST 2020').date(), + due_date=dateutil_parser('Fri Oct 30 01:00:00 CET 2020').date(), + paid_date=dateutil_parser('Fri Oct 30 01:00:00 CET 2020').date(), + po_number="90000117", + reference="123456", + line_items=[ + BillLineItem( + row_id="12345", + code="120-C", + line_number=1, + description="Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", + type="expense_account", + tax_amount=27500, + total_amount=27500, + quantity=1, + unit_price=27500.5, + unit_of_measure="pc.", + discount_percentage=0.01, + location_id="1234", + department_id="1234", + item=LinkedInvoiceItem( + id="12344", + ), + ledger_account=LinkedLedgerAccount( + id="123456", + nominal_code="N091", + code="453", + ), + tax_rate=LinkedTaxRate( + id="123456", + ), + row_version="1-12345", + ), + ], + terms="Net 30 days", + balance=27500, + deposit=0, + sub_total=27500, + total_tax=2500, + total=27500, + tax_code="1234", + notes="Some notes about this bill.", + status="draft", + ledger_account=LinkedLedgerAccount( + id="123456", + nominal_code="N091", + code="453", + ), + bill_number="10001", + row_version="1-12345", + ) # Bill | + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + + # example passing only required values which don't have defaults set + try: + # Create Bill + api_response = api_instance.bills_add(bill) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling AccountingApi->bills_add: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Create Bill + api_response = api_instance.bills_add(bill, raw=raw, consumer_id=consumer_id, app_id=app_id, service_id=service_id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling AccountingApi->bills_add: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **bill** | [**Bill**](Bill.md)| | + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + +### Return type + +[**CreateBillResponse**](CreateBillResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**201** | Bill created | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **bills_all** +> GetBillsResponse bills_all() + +List Bills + +List Bills + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import accounting_api +from apideck.model.get_bills_response import GetBillsResponse +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = accounting_api.AccountingApi(api_client) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + cursor = "cursor_example" # str, none_type | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. (optional) + limit = 20 # int | Number of records to return (optional) if omitted the server will use the default value of 20 + + # example passing only required values which don't have defaults set + # and optional values + try: + # List Bills + api_response = api_instance.bills_all(raw=raw, consumer_id=consumer_id, app_id=app_id, service_id=service_id, cursor=cursor, limit=limit) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling AccountingApi->bills_all: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **cursor** | **str, none_type**| Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | [optional] + **limit** | **int**| Number of records to return | [optional] if omitted the server will use the default value of 20 + +### Return type + +[**GetBillsResponse**](GetBillsResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Bills | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **bills_delete** +> DeleteBillResponse bills_delete(id) + +Delete Bill + +Delete Bill + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import accounting_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.delete_bill_response import DeleteBillResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = accounting_api.AccountingApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # Delete Bill + api_response = api_instance.bills_delete(id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling AccountingApi->bills_delete: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Delete Bill + api_response = api_instance.bills_delete(id, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling AccountingApi->bills_delete: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + +### Return type + +[**DeleteBillResponse**](DeleteBillResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Bill deleted | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **bills_one** +> GetBillResponse bills_one(id) + +Get Bill + +Get Bill + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import accounting_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.get_bill_response import GetBillResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = accounting_api.AccountingApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # Get Bill + api_response = api_instance.bills_one(id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling AccountingApi->bills_one: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get Bill + api_response = api_instance.bills_one(id, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling AccountingApi->bills_one: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + +### Return type + +[**GetBillResponse**](GetBillResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Bill | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **bills_update** +> UpdateBillResponse bills_update(id, bill) + +Update Bill + +Update Bill + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import accounting_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.bill import Bill +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.update_bill_response import UpdateBillResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = accounting_api.AccountingApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + bill = Bill( + supplier=LinkedSupplier( + id="12345", + display_name="Windsurf Shop", + address=Address( + id="123", + type="primary", + string="25 Spring Street, Blackburn, VIC 3130", + name="HQ US", + line1="Main street", + line2="apt #", + line3="Suite #", + line4="delivery instructions", + street_number="25", + city="San Francisco", + state="CA", + postal_code="94104", + country="US", + latitude="40.759211", + longitude="-73.984638", + county="Santa Clara", + contact_name="Elon Musk", + salutation="Mr", + phone_number="111-111-1111", + fax="122-111-1111", + email="elon@musk.com", + website="https://elonmusk.com", + row_version="1-12345", + ), + ), + currency=Currency("USD"), + currency_rate=0.69, + tax_inclusive=True, + bill_date=dateutil_parser('Wed Sep 30 02:00:00 CEST 2020').date(), + due_date=dateutil_parser('Fri Oct 30 01:00:00 CET 2020').date(), + paid_date=dateutil_parser('Fri Oct 30 01:00:00 CET 2020').date(), + po_number="90000117", + reference="123456", + line_items=[ + BillLineItem( + row_id="12345", + code="120-C", + line_number=1, + description="Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", + type="expense_account", + tax_amount=27500, + total_amount=27500, + quantity=1, + unit_price=27500.5, + unit_of_measure="pc.", + discount_percentage=0.01, + location_id="1234", + department_id="1234", + item=LinkedInvoiceItem( + id="12344", + ), + ledger_account=LinkedLedgerAccount( + id="123456", + nominal_code="N091", + code="453", + ), + tax_rate=LinkedTaxRate( + id="123456", + ), + row_version="1-12345", + ), + ], + terms="Net 30 days", + balance=27500, + deposit=0, + sub_total=27500, + total_tax=2500, + total=27500, + tax_code="1234", + notes="Some notes about this bill.", + status="draft", + ledger_account=LinkedLedgerAccount( + id="123456", + nominal_code="N091", + code="453", + ), + bill_number="10001", + row_version="1-12345", + ) # Bill | + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # Update Bill + api_response = api_instance.bills_update(id, bill) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling AccountingApi->bills_update: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Update Bill + api_response = api_instance.bills_update(id, bill, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling AccountingApi->bills_update: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **bill** | [**Bill**](Bill.md)| | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + +### Return type + +[**UpdateBillResponse**](UpdateBillResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Bill Updated | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **company_info_one** +> GetCompanyInfoResponse company_info_one() + +Get company info + +Get company info + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import accounting_api +from apideck.model.get_company_info_response import GetCompanyInfoResponse +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = accounting_api.AccountingApi(api_client) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get company info + api_response = api_instance.company_info_one(raw=raw, consumer_id=consumer_id, app_id=app_id, service_id=service_id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling AccountingApi->company_info_one: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + +### Return type + +[**GetCompanyInfoResponse**](GetCompanyInfoResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | CompanyInfo | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **credit_notes_add** +> CreateCreditNoteResponse credit_notes_add(credit_note) + +Create Credit Note + +Create Credit Note + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import accounting_api +from apideck.model.create_credit_note_response import CreateCreditNoteResponse +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.credit_note import CreditNote +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = accounting_api.AccountingApi(api_client) + credit_note = CreditNote( + number="OIT00546", + customer=LinkedCustomer( + id="12345", + display_name="Windsurf Shop", + name="Windsurf Shop", + ), + currency=Currency("USD"), + currency_rate=0.69, + tax_inclusive=True, + sub_total=27500, + total_amount=49.99, + total_tax=2500, + tax_code="1234", + balance=27500, + remaining_credit=27500, + status="authorised", + reference="123456", + date_issued=dateutil_parser('2021-05-01T12:00:00Z'), + date_paid=dateutil_parser('2021-05-01T12:00:00Z'), + type="accounts_receivable_credit", + account=LinkedLedgerAccount( + id="123456", + nominal_code="N091", + code="453", + ), + line_items=[ + InvoiceLineItem( + row_id="12345", + code="120-C", + line_number=1, + description="Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", + type="sales_item", + tax_amount=27500, + total_amount=27500, + quantity=1, + unit_price=27500.5, + unit_of_measure="pc.", + discount_percentage=0.01, + location_id="1234", + department_id="1234", + item=LinkedInvoiceItem( + id="12344", + ), + tax_rate=LinkedTaxRate( + id="123456", + ), + ledger_account=LinkedLedgerAccount( + id="123456", + nominal_code="N091", + code="453", + ), + row_version="1-12345", + ), + ], + allocations=[ + None, + ], + note="Some notes about this credit note", + row_version="1-12345", + ) # CreditNote | + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + + # example passing only required values which don't have defaults set + try: + # Create Credit Note + api_response = api_instance.credit_notes_add(credit_note) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling AccountingApi->credit_notes_add: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Create Credit Note + api_response = api_instance.credit_notes_add(credit_note, raw=raw, consumer_id=consumer_id, app_id=app_id, service_id=service_id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling AccountingApi->credit_notes_add: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **credit_note** | [**CreditNote**](CreditNote.md)| | + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + +### Return type + +[**CreateCreditNoteResponse**](CreateCreditNoteResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**201** | Credit Note created | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **credit_notes_all** +> GetCreditNotesResponse credit_notes_all() + +List Credit Notes + +List Credit Notes + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import accounting_api +from apideck.model.get_credit_notes_response import GetCreditNotesResponse +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = accounting_api.AccountingApi(api_client) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + cursor = "cursor_example" # str, none_type | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. (optional) + limit = 20 # int | Number of records to return (optional) if omitted the server will use the default value of 20 + + # example passing only required values which don't have defaults set + # and optional values + try: + # List Credit Notes + api_response = api_instance.credit_notes_all(raw=raw, consumer_id=consumer_id, app_id=app_id, service_id=service_id, cursor=cursor, limit=limit) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling AccountingApi->credit_notes_all: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **cursor** | **str, none_type**| Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | [optional] + **limit** | **int**| Number of records to return | [optional] if omitted the server will use the default value of 20 + +### Return type + +[**GetCreditNotesResponse**](GetCreditNotesResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Credit Notes | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **credit_notes_delete** +> DeleteCreditNoteResponse credit_notes_delete(id) + +Delete Credit Note + +Delete Credit Note + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import accounting_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.delete_credit_note_response import DeleteCreditNoteResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = accounting_api.AccountingApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # Delete Credit Note + api_response = api_instance.credit_notes_delete(id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling AccountingApi->credit_notes_delete: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Delete Credit Note + api_response = api_instance.credit_notes_delete(id, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling AccountingApi->credit_notes_delete: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + +### Return type + +[**DeleteCreditNoteResponse**](DeleteCreditNoteResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Credit Note deleted | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **credit_notes_one** +> GetCreditNoteResponse credit_notes_one(id) + +Get Credit Note + +Get Credit Note + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import accounting_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.get_credit_note_response import GetCreditNoteResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = accounting_api.AccountingApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # Get Credit Note + api_response = api_instance.credit_notes_one(id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling AccountingApi->credit_notes_one: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get Credit Note + api_response = api_instance.credit_notes_one(id, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling AccountingApi->credit_notes_one: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + +### Return type + +[**GetCreditNoteResponse**](GetCreditNoteResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Credit Note | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **credit_notes_update** +> UpdateCreditNoteResponse credit_notes_update(id, credit_note) + +Update Credit Note + +Update Credit Note + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import accounting_api +from apideck.model.update_credit_note_response import UpdateCreditNoteResponse +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.credit_note import CreditNote +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = accounting_api.AccountingApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + credit_note = CreditNote( + number="OIT00546", + customer=LinkedCustomer( + id="12345", + display_name="Windsurf Shop", + name="Windsurf Shop", + ), + currency=Currency("USD"), + currency_rate=0.69, + tax_inclusive=True, + sub_total=27500, + total_amount=49.99, + total_tax=2500, + tax_code="1234", + balance=27500, + remaining_credit=27500, + status="authorised", + reference="123456", + date_issued=dateutil_parser('2021-05-01T12:00:00Z'), + date_paid=dateutil_parser('2021-05-01T12:00:00Z'), + type="accounts_receivable_credit", + account=LinkedLedgerAccount( + id="123456", + nominal_code="N091", + code="453", + ), + line_items=[ + InvoiceLineItem( + row_id="12345", + code="120-C", + line_number=1, + description="Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", + type="sales_item", + tax_amount=27500, + total_amount=27500, + quantity=1, + unit_price=27500.5, + unit_of_measure="pc.", + discount_percentage=0.01, + location_id="1234", + department_id="1234", + item=LinkedInvoiceItem( + id="12344", + ), + tax_rate=LinkedTaxRate( + id="123456", + ), + ledger_account=LinkedLedgerAccount( + id="123456", + nominal_code="N091", + code="453", + ), + row_version="1-12345", + ), + ], + allocations=[ + None, + ], + note="Some notes about this credit note", + row_version="1-12345", + ) # CreditNote | + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # Update Credit Note + api_response = api_instance.credit_notes_update(id, credit_note) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling AccountingApi->credit_notes_update: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Update Credit Note + api_response = api_instance.credit_notes_update(id, credit_note, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling AccountingApi->credit_notes_update: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **credit_note** | [**CreditNote**](CreditNote.md)| | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + +### Return type + +[**UpdateCreditNoteResponse**](UpdateCreditNoteResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Credit Note updated | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **customers_add** +> CreateCustomerResponse customers_add(accounting_customer) + +Create Customer + +Create Customer + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import accounting_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.accounting_customer import AccountingCustomer +from apideck.model.create_customer_response import CreateCustomerResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = accounting_api.AccountingApi(api_client) + accounting_customer = AccountingCustomer( + display_id="EMP00101", + display_name="Windsurf Shop", + company_name="SpaceX", + title="CEO", + first_name="Elon", + middle_name="D.", + last_name="Musk", + suffix="Jr.", + individual=True, + addresses=[ + Address( + id="123", + type="primary", + string="25 Spring Street, Blackburn, VIC 3130", + name="HQ US", + line1="Main street", + line2="apt #", + line3="Suite #", + line4="delivery instructions", + street_number="25", + city="San Francisco", + state="CA", + postal_code="94104", + country="US", + latitude="40.759211", + longitude="-73.984638", + county="Santa Clara", + contact_name="Elon Musk", + salutation="Mr", + phone_number="111-111-1111", + fax="122-111-1111", + email="elon@musk.com", + website="https://elonmusk.com", + row_version="1-12345", + ), + ], + notes="Some notes about this customer", + phone_numbers=[ + PhoneNumber( + id="12345", + country_code="1", + area_code="323", + number="111-111-1111", + extension="105", + type="primary", + ), + ], + emails=[ + Email( + id="123", + email="elon@musk.com", + type="primary", + ), + ], + websites=[ + Website( + id="12345", + url="http://example.com", + type="primary", + ), + ], + tax_rate=LinkedTaxRate( + id="123456", + ), + tax_number="US123945459", + currency=Currency("USD"), + bank_accounts=[ + BankAccount( + iban="CH2989144532982975332", + bic="AUDSCHGGXXX", + bsb_number="062-001", + branch_identifier="001", + bank_code="BNH", + account_number="123465", + account_name="SPACEX LLC", + account_type="credit_card", + currency=Currency("USD"), + ), + ], + status="active", + row_version="1-12345", + ) # AccountingCustomer | + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + + # example passing only required values which don't have defaults set + try: + # Create Customer + api_response = api_instance.customers_add(accounting_customer) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling AccountingApi->customers_add: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Create Customer + api_response = api_instance.customers_add(accounting_customer, raw=raw, consumer_id=consumer_id, app_id=app_id, service_id=service_id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling AccountingApi->customers_add: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **accounting_customer** | [**AccountingCustomer**](AccountingCustomer.md)| | + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + +### Return type + +[**CreateCustomerResponse**](CreateCustomerResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**201** | Customers | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **customers_all** +> GetCustomersResponse customers_all() + +List Customers + +List Customers + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import accounting_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.customers_filter import CustomersFilter +from apideck.model.get_customers_response import GetCustomersResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = accounting_api.AccountingApi(api_client) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + cursor = "cursor_example" # str, none_type | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. (optional) + limit = 20 # int | Number of records to return (optional) if omitted the server will use the default value of 20 + filter = CustomersFilter( + company_name="SpaceX", + display_name="Techno King", + first_name="Elon", + last_name="Musk", + email="elon@spacex.com", + ) # CustomersFilter | Apply filters (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + # List Customers + api_response = api_instance.customers_all(raw=raw, consumer_id=consumer_id, app_id=app_id, service_id=service_id, cursor=cursor, limit=limit, filter=filter) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling AccountingApi->customers_all: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **cursor** | **str, none_type**| Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | [optional] + **limit** | **int**| Number of records to return | [optional] if omitted the server will use the default value of 20 + **filter** | **CustomersFilter**| Apply filters | [optional] + +### Return type + +[**GetCustomersResponse**](GetCustomersResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Customers | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **customers_delete** +> DeleteCustomerResponse customers_delete(id) + +Delete Customer + +Delete Customer + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import accounting_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.delete_customer_response import DeleteCustomerResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = accounting_api.AccountingApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # Delete Customer + api_response = api_instance.customers_delete(id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling AccountingApi->customers_delete: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Delete Customer + api_response = api_instance.customers_delete(id, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling AccountingApi->customers_delete: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + +### Return type + +[**DeleteCustomerResponse**](DeleteCustomerResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Customers | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **customers_one** +> GetCustomerResponse customers_one(id) + +Get Customer + +Get Customer + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import accounting_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.get_customer_response import GetCustomerResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = accounting_api.AccountingApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # Get Customer + api_response = api_instance.customers_one(id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling AccountingApi->customers_one: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get Customer + api_response = api_instance.customers_one(id, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling AccountingApi->customers_one: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + +### Return type + +[**GetCustomerResponse**](GetCustomerResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Customer | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **customers_update** +> UpdateCustomerResponse customers_update(id, accounting_customer) + +Update Customer + +Update Customer + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import accounting_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.accounting_customer import AccountingCustomer +from apideck.model.update_customer_response import UpdateCustomerResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = accounting_api.AccountingApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + accounting_customer = AccountingCustomer( + display_id="EMP00101", + display_name="Windsurf Shop", + company_name="SpaceX", + title="CEO", + first_name="Elon", + middle_name="D.", + last_name="Musk", + suffix="Jr.", + individual=True, + addresses=[ + Address( + id="123", + type="primary", + string="25 Spring Street, Blackburn, VIC 3130", + name="HQ US", + line1="Main street", + line2="apt #", + line3="Suite #", + line4="delivery instructions", + street_number="25", + city="San Francisco", + state="CA", + postal_code="94104", + country="US", + latitude="40.759211", + longitude="-73.984638", + county="Santa Clara", + contact_name="Elon Musk", + salutation="Mr", + phone_number="111-111-1111", + fax="122-111-1111", + email="elon@musk.com", + website="https://elonmusk.com", + row_version="1-12345", + ), + ], + notes="Some notes about this customer", + phone_numbers=[ + PhoneNumber( + id="12345", + country_code="1", + area_code="323", + number="111-111-1111", + extension="105", + type="primary", + ), + ], + emails=[ + Email( + id="123", + email="elon@musk.com", + type="primary", + ), + ], + websites=[ + Website( + id="12345", + url="http://example.com", + type="primary", + ), + ], + tax_rate=LinkedTaxRate( + id="123456", + ), + tax_number="US123945459", + currency=Currency("USD"), + bank_accounts=[ + BankAccount( + iban="CH2989144532982975332", + bic="AUDSCHGGXXX", + bsb_number="062-001", + branch_identifier="001", + bank_code="BNH", + account_number="123465", + account_name="SPACEX LLC", + account_type="credit_card", + currency=Currency("USD"), + ), + ], + status="active", + row_version="1-12345", + ) # AccountingCustomer | + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # Update Customer + api_response = api_instance.customers_update(id, accounting_customer) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling AccountingApi->customers_update: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Update Customer + api_response = api_instance.customers_update(id, accounting_customer, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling AccountingApi->customers_update: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **accounting_customer** | [**AccountingCustomer**](AccountingCustomer.md)| | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + +### Return type + +[**UpdateCustomerResponse**](UpdateCustomerResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Customers | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **invoice_items_add** +> CreateInvoiceItemResponse invoice_items_add(invoice_item) + +Create Invoice Item + +Create Invoice Item + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import accounting_api +from apideck.model.invoice_item import InvoiceItem +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.create_invoice_item_response import CreateInvoiceItemResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = accounting_api.AccountingApi(api_client) + invoice_item = InvoiceItem( + name="Model Y", + description="Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", + code="120-C", + sold=True, + purchased=True, + tracked=True, + inventory_date=dateutil_parser('Fri Oct 30 01:00:00 CET 2020').date(), + type="inventory", + sales_details=InvoiceItemSalesDetails( + unit_price=27500.5, + unit_of_measure="pc.", + tax_inclusive=True, + tax_rate=LinkedTaxRate( + id="123456", + ), + ), + purchase_details=InvoiceItemSalesDetails( + unit_price=27500.5, + unit_of_measure="pc.", + tax_inclusive=True, + tax_rate=LinkedTaxRate( + id="123456", + ), + ), + quantity=1, + unit_price=27500.5, + asset_account=LinkedLedgerAccount( + id="123456", + nominal_code="N091", + code="453", + ), + income_account=LinkedLedgerAccount( + id="123456", + nominal_code="N091", + code="453", + ), + expense_account=LinkedLedgerAccount( + id="123456", + nominal_code="N091", + code="453", + ), + active=True, + row_version="1-12345", + ) # InvoiceItem | + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + + # example passing only required values which don't have defaults set + try: + # Create Invoice Item + api_response = api_instance.invoice_items_add(invoice_item) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling AccountingApi->invoice_items_add: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Create Invoice Item + api_response = api_instance.invoice_items_add(invoice_item, raw=raw, consumer_id=consumer_id, app_id=app_id, service_id=service_id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling AccountingApi->invoice_items_add: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **invoice_item** | [**InvoiceItem**](InvoiceItem.md)| | + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + +### Return type + +[**CreateInvoiceItemResponse**](CreateInvoiceItemResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**201** | InvoiceItems | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **invoice_items_all** +> GetInvoiceItemsResponse invoice_items_all() + +List Invoice Items + +List Invoice Items + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import accounting_api +from apideck.model.invoice_items_filter import InvoiceItemsFilter +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.get_invoice_items_response import GetInvoiceItemsResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = accounting_api.AccountingApi(api_client) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + cursor = "cursor_example" # str, none_type | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. (optional) + limit = 20 # int | Number of records to return (optional) if omitted the server will use the default value of 20 + filter = InvoiceItemsFilter( + name="Widgets Large", + ) # InvoiceItemsFilter | Apply filters (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + # List Invoice Items + api_response = api_instance.invoice_items_all(raw=raw, consumer_id=consumer_id, app_id=app_id, service_id=service_id, cursor=cursor, limit=limit, filter=filter) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling AccountingApi->invoice_items_all: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **cursor** | **str, none_type**| Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | [optional] + **limit** | **int**| Number of records to return | [optional] if omitted the server will use the default value of 20 + **filter** | **InvoiceItemsFilter**| Apply filters | [optional] + +### Return type + +[**GetInvoiceItemsResponse**](GetInvoiceItemsResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | InvoiceItems | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **invoice_items_delete** +> DeleteTaxRateResponse invoice_items_delete(id) + +Delete Invoice Item + +Delete Invoice Item + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import accounting_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.delete_tax_rate_response import DeleteTaxRateResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = accounting_api.AccountingApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # Delete Invoice Item + api_response = api_instance.invoice_items_delete(id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling AccountingApi->invoice_items_delete: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Delete Invoice Item + api_response = api_instance.invoice_items_delete(id, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling AccountingApi->invoice_items_delete: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + +### Return type + +[**DeleteTaxRateResponse**](DeleteTaxRateResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | InvoiceItems | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **invoice_items_one** +> GetInvoiceItemResponse invoice_items_one(id) + +Get Invoice Item + +Get Invoice Item + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import accounting_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.get_invoice_item_response import GetInvoiceItemResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = accounting_api.AccountingApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # Get Invoice Item + api_response = api_instance.invoice_items_one(id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling AccountingApi->invoice_items_one: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get Invoice Item + api_response = api_instance.invoice_items_one(id, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling AccountingApi->invoice_items_one: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + +### Return type + +[**GetInvoiceItemResponse**](GetInvoiceItemResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | InvoiceItems | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **invoice_items_update** +> UpdateInvoiceItemsResponse invoice_items_update(id, invoice_item) + +Update Invoice Item + +Update Invoice Item + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import accounting_api +from apideck.model.invoice_item import InvoiceItem +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.update_invoice_items_response import UpdateInvoiceItemsResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = accounting_api.AccountingApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + invoice_item = InvoiceItem( + name="Model Y", + description="Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", + code="120-C", + sold=True, + purchased=True, + tracked=True, + inventory_date=dateutil_parser('Fri Oct 30 01:00:00 CET 2020').date(), + type="inventory", + sales_details=InvoiceItemSalesDetails( + unit_price=27500.5, + unit_of_measure="pc.", + tax_inclusive=True, + tax_rate=LinkedTaxRate( + id="123456", + ), + ), + purchase_details=InvoiceItemSalesDetails( + unit_price=27500.5, + unit_of_measure="pc.", + tax_inclusive=True, + tax_rate=LinkedTaxRate( + id="123456", + ), + ), + quantity=1, + unit_price=27500.5, + asset_account=LinkedLedgerAccount( + id="123456", + nominal_code="N091", + code="453", + ), + income_account=LinkedLedgerAccount( + id="123456", + nominal_code="N091", + code="453", + ), + expense_account=LinkedLedgerAccount( + id="123456", + nominal_code="N091", + code="453", + ), + active=True, + row_version="1-12345", + ) # InvoiceItem | + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # Update Invoice Item + api_response = api_instance.invoice_items_update(id, invoice_item) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling AccountingApi->invoice_items_update: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Update Invoice Item + api_response = api_instance.invoice_items_update(id, invoice_item, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling AccountingApi->invoice_items_update: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **invoice_item** | [**InvoiceItem**](InvoiceItem.md)| | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + +### Return type + +[**UpdateInvoiceItemsResponse**](UpdateInvoiceItemsResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | InvoiceItems | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **invoices_add** +> CreateInvoiceResponse invoices_add(invoice) + +Create Invoice + +Create Invoice + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import accounting_api +from apideck.model.invoice import Invoice +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.create_invoice_response import CreateInvoiceResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = accounting_api.AccountingApi(api_client) + invoice = Invoice( + type="service", + number="OIT00546", + customer=LinkedCustomer( + id="12345", + display_name="Windsurf Shop", + name="Windsurf Shop", + ), + invoice_date=dateutil_parser('Wed Sep 30 02:00:00 CEST 2020').date(), + due_date=dateutil_parser('Wed Sep 30 02:00:00 CEST 2020').date(), + terms="Net 30 days", + po_number="90000117", + reference="123456", + status="draft", + invoice_sent=True, + currency=Currency("USD"), + currency_rate=0.69, + tax_inclusive=True, + sub_total=27500, + total_tax=2500, + tax_code="1234", + discount_percentage=5.5, + total=27500, + balance=27500, + deposit=0, + customer_memo="Thank you for your business and have a great day!", + line_items=[ + InvoiceLineItem( + row_id="12345", + code="120-C", + line_number=1, + description="Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", + type="sales_item", + tax_amount=27500, + total_amount=27500, + quantity=1, + unit_price=27500.5, + unit_of_measure="pc.", + discount_percentage=0.01, + location_id="1234", + department_id="1234", + item=LinkedInvoiceItem( + id="12344", + ), + tax_rate=LinkedTaxRate( + id="123456", + ), + ledger_account=LinkedLedgerAccount( + id="123456", + nominal_code="N091", + code="453", + ), + row_version="1-12345", + ), + ], + billing_address=Address( + id="123", + type="primary", + string="25 Spring Street, Blackburn, VIC 3130", + name="HQ US", + line1="Main street", + line2="apt #", + line3="Suite #", + line4="delivery instructions", + street_number="25", + city="San Francisco", + state="CA", + postal_code="94104", + country="US", + latitude="40.759211", + longitude="-73.984638", + county="Santa Clara", + contact_name="Elon Musk", + salutation="Mr", + phone_number="111-111-1111", + fax="122-111-1111", + email="elon@musk.com", + website="https://elonmusk.com", + row_version="1-12345", + ), + shipping_address=Address( + id="123", + type="primary", + string="25 Spring Street, Blackburn, VIC 3130", + name="HQ US", + line1="Main street", + line2="apt #", + line3="Suite #", + line4="delivery instructions", + street_number="25", + city="San Francisco", + state="CA", + postal_code="94104", + country="US", + latitude="40.759211", + longitude="-73.984638", + county="Santa Clara", + contact_name="Elon Musk", + salutation="Mr", + phone_number="111-111-1111", + fax="122-111-1111", + email="elon@musk.com", + website="https://elonmusk.com", + row_version="1-12345", + ), + template_id="123456", + source_document_url="https://www.invoicesolution.com/invoice/123456", + row_version="1-12345", + ) # Invoice | + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + + # example passing only required values which don't have defaults set + try: + # Create Invoice + api_response = api_instance.invoices_add(invoice) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling AccountingApi->invoices_add: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Create Invoice + api_response = api_instance.invoices_add(invoice, raw=raw, consumer_id=consumer_id, app_id=app_id, service_id=service_id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling AccountingApi->invoices_add: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **invoice** | [**Invoice**](Invoice.md)| | + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + +### Return type + +[**CreateInvoiceResponse**](CreateInvoiceResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**201** | Invoice created | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **invoices_all** +> GetInvoicesResponse invoices_all() + +List Invoices + +List Invoices + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import accounting_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.invoices_sort import InvoicesSort +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.get_invoices_response import GetInvoicesResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = accounting_api.AccountingApi(api_client) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + cursor = "cursor_example" # str, none_type | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. (optional) + limit = 20 # int | Number of records to return (optional) if omitted the server will use the default value of 20 + sort = InvoicesSort( + by="updated_at", + direction=SortDirection("asc"), + ) # InvoicesSort | Apply sorting (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + # List Invoices + api_response = api_instance.invoices_all(raw=raw, consumer_id=consumer_id, app_id=app_id, service_id=service_id, cursor=cursor, limit=limit, sort=sort) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling AccountingApi->invoices_all: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **cursor** | **str, none_type**| Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | [optional] + **limit** | **int**| Number of records to return | [optional] if omitted the server will use the default value of 20 + **sort** | **InvoicesSort**| Apply sorting | [optional] + +### Return type + +[**GetInvoicesResponse**](GetInvoicesResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Invoices | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **invoices_delete** +> DeleteInvoiceResponse invoices_delete(id) + +Delete Invoice + +Delete Invoice + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import accounting_api +from apideck.model.delete_invoice_response import DeleteInvoiceResponse +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = accounting_api.AccountingApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # Delete Invoice + api_response = api_instance.invoices_delete(id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling AccountingApi->invoices_delete: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Delete Invoice + api_response = api_instance.invoices_delete(id, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling AccountingApi->invoices_delete: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + +### Return type + +[**DeleteInvoiceResponse**](DeleteInvoiceResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Invoice deleted | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **invoices_one** +> GetInvoiceResponse invoices_one(id) + +Get Invoice + +Get Invoice + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import accounting_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.get_invoice_response import GetInvoiceResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = accounting_api.AccountingApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # Get Invoice + api_response = api_instance.invoices_one(id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling AccountingApi->invoices_one: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get Invoice + api_response = api_instance.invoices_one(id, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling AccountingApi->invoices_one: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + +### Return type + +[**GetInvoiceResponse**](GetInvoiceResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Invoice | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **invoices_update** +> UpdateInvoiceResponse invoices_update(id, invoice) + +Update Invoice + +Update Invoice + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import accounting_api +from apideck.model.invoice import Invoice +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.update_invoice_response import UpdateInvoiceResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = accounting_api.AccountingApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + invoice = Invoice( + type="service", + number="OIT00546", + customer=LinkedCustomer( + id="12345", + display_name="Windsurf Shop", + name="Windsurf Shop", + ), + invoice_date=dateutil_parser('Wed Sep 30 02:00:00 CEST 2020').date(), + due_date=dateutil_parser('Wed Sep 30 02:00:00 CEST 2020').date(), + terms="Net 30 days", + po_number="90000117", + reference="123456", + status="draft", + invoice_sent=True, + currency=Currency("USD"), + currency_rate=0.69, + tax_inclusive=True, + sub_total=27500, + total_tax=2500, + tax_code="1234", + discount_percentage=5.5, + total=27500, + balance=27500, + deposit=0, + customer_memo="Thank you for your business and have a great day!", + line_items=[ + InvoiceLineItem( + row_id="12345", + code="120-C", + line_number=1, + description="Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", + type="sales_item", + tax_amount=27500, + total_amount=27500, + quantity=1, + unit_price=27500.5, + unit_of_measure="pc.", + discount_percentage=0.01, + location_id="1234", + department_id="1234", + item=LinkedInvoiceItem( + id="12344", + ), + tax_rate=LinkedTaxRate( + id="123456", + ), + ledger_account=LinkedLedgerAccount( + id="123456", + nominal_code="N091", + code="453", + ), + row_version="1-12345", + ), + ], + billing_address=Address( + id="123", + type="primary", + string="25 Spring Street, Blackburn, VIC 3130", + name="HQ US", + line1="Main street", + line2="apt #", + line3="Suite #", + line4="delivery instructions", + street_number="25", + city="San Francisco", + state="CA", + postal_code="94104", + country="US", + latitude="40.759211", + longitude="-73.984638", + county="Santa Clara", + contact_name="Elon Musk", + salutation="Mr", + phone_number="111-111-1111", + fax="122-111-1111", + email="elon@musk.com", + website="https://elonmusk.com", + row_version="1-12345", + ), + shipping_address=Address( + id="123", + type="primary", + string="25 Spring Street, Blackburn, VIC 3130", + name="HQ US", + line1="Main street", + line2="apt #", + line3="Suite #", + line4="delivery instructions", + street_number="25", + city="San Francisco", + state="CA", + postal_code="94104", + country="US", + latitude="40.759211", + longitude="-73.984638", + county="Santa Clara", + contact_name="Elon Musk", + salutation="Mr", + phone_number="111-111-1111", + fax="122-111-1111", + email="elon@musk.com", + website="https://elonmusk.com", + row_version="1-12345", + ), + template_id="123456", + source_document_url="https://www.invoicesolution.com/invoice/123456", + row_version="1-12345", + ) # Invoice | + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # Update Invoice + api_response = api_instance.invoices_update(id, invoice) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling AccountingApi->invoices_update: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Update Invoice + api_response = api_instance.invoices_update(id, invoice, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling AccountingApi->invoices_update: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **invoice** | [**Invoice**](Invoice.md)| | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + +### Return type + +[**UpdateInvoiceResponse**](UpdateInvoiceResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Invoice updated | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **ledger_accounts_add** +> CreateLedgerAccountResponse ledger_accounts_add(ledger_account) + +Create Ledger Account + +Create Ledger Account + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import accounting_api +from apideck.model.ledger_account import LedgerAccount +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.create_ledger_account_response import CreateLedgerAccountResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = accounting_api.AccountingApi(api_client) + ledger_account = LedgerAccount() # LedgerAccount | + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + + # example passing only required values which don't have defaults set + try: + # Create Ledger Account + api_response = api_instance.ledger_accounts_add(ledger_account) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling AccountingApi->ledger_accounts_add: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Create Ledger Account + api_response = api_instance.ledger_accounts_add(ledger_account, raw=raw, consumer_id=consumer_id, app_id=app_id, service_id=service_id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling AccountingApi->ledger_accounts_add: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ledger_account** | [**LedgerAccount**](LedgerAccount.md)| | + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + +### Return type + +[**CreateLedgerAccountResponse**](CreateLedgerAccountResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**201** | LedgerAccount created | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **ledger_accounts_all** +> GetLedgerAccountsResponse ledger_accounts_all() + +List Ledger Accounts + +List Ledger Accounts + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import accounting_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.get_ledger_accounts_response import GetLedgerAccountsResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = accounting_api.AccountingApi(api_client) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + cursor = "cursor_example" # str, none_type | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. (optional) + limit = 20 # int | Number of records to return (optional) if omitted the server will use the default value of 20 + + # example passing only required values which don't have defaults set + # and optional values + try: + # List Ledger Accounts + api_response = api_instance.ledger_accounts_all(raw=raw, consumer_id=consumer_id, app_id=app_id, service_id=service_id, cursor=cursor, limit=limit) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling AccountingApi->ledger_accounts_all: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **cursor** | **str, none_type**| Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | [optional] + **limit** | **int**| Number of records to return | [optional] if omitted the server will use the default value of 20 + +### Return type + +[**GetLedgerAccountsResponse**](GetLedgerAccountsResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | LedgerAccounts | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **ledger_accounts_delete** +> DeleteLedgerAccountResponse ledger_accounts_delete(id) + +Delete Ledger Account + +Delete Ledger Account + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import accounting_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.delete_ledger_account_response import DeleteLedgerAccountResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = accounting_api.AccountingApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # Delete Ledger Account + api_response = api_instance.ledger_accounts_delete(id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling AccountingApi->ledger_accounts_delete: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Delete Ledger Account + api_response = api_instance.ledger_accounts_delete(id, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling AccountingApi->ledger_accounts_delete: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + +### Return type + +[**DeleteLedgerAccountResponse**](DeleteLedgerAccountResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | LedgerAccount deleted | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **ledger_accounts_one** +> GetLedgerAccountResponse ledger_accounts_one(id) + +Get Ledger Account + +Get Ledger Account + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import accounting_api +from apideck.model.get_ledger_account_response import GetLedgerAccountResponse +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = accounting_api.AccountingApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # Get Ledger Account + api_response = api_instance.ledger_accounts_one(id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling AccountingApi->ledger_accounts_one: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get Ledger Account + api_response = api_instance.ledger_accounts_one(id, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling AccountingApi->ledger_accounts_one: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + +### Return type + +[**GetLedgerAccountResponse**](GetLedgerAccountResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | LedgerAccount | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **ledger_accounts_update** +> UpdateLedgerAccountResponse ledger_accounts_update(id, ledger_account) + +Update Ledger Account + +Update Ledger Account + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import accounting_api +from apideck.model.ledger_account import LedgerAccount +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.update_ledger_account_response import UpdateLedgerAccountResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = accounting_api.AccountingApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + ledger_account = LedgerAccount() # LedgerAccount | + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # Update Ledger Account + api_response = api_instance.ledger_accounts_update(id, ledger_account) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling AccountingApi->ledger_accounts_update: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Update Ledger Account + api_response = api_instance.ledger_accounts_update(id, ledger_account, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling AccountingApi->ledger_accounts_update: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **ledger_account** | [**LedgerAccount**](LedgerAccount.md)| | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + +### Return type + +[**UpdateLedgerAccountResponse**](UpdateLedgerAccountResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | LedgerAccount updated | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **payments_add** +> CreatePaymentResponse payments_add(payment) + +Create Payment + +Create Payment + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import accounting_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.create_payment_response import CreatePaymentResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.payment import Payment +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = accounting_api.AccountingApi(api_client) + payment = Payment( + currency=Currency("USD"), + currency_rate=0.69, + total_amount=49.99, + reference="123456", + payment_method="Credit Card", + payment_method_reference="123456", + accounts_receivable_account_type="Account", + accounts_receivable_account_id="123456", + account=LinkedLedgerAccount( + id="123456", + nominal_code="N091", + code="453", + ), + transaction_date=dateutil_parser('2021-05-01T12:00:00Z'), + customer=LinkedCustomer( + id="12345", + display_name="Windsurf Shop", + name="Windsurf Shop", + ), + supplier=LinkedSupplier( + id="12345", + display_name="Windsurf Shop", + address=Address( + id="123", + type="primary", + string="25 Spring Street, Blackburn, VIC 3130", + name="HQ US", + line1="Main street", + line2="apt #", + line3="Suite #", + line4="delivery instructions", + street_number="25", + city="San Francisco", + state="CA", + postal_code="94104", + country="US", + latitude="40.759211", + longitude="-73.984638", + county="Santa Clara", + contact_name="Elon Musk", + salutation="Mr", + phone_number="111-111-1111", + fax="122-111-1111", + email="elon@musk.com", + website="https://elonmusk.com", + row_version="1-12345", + ), + ), + reconciled=True, + status="authorised", + type="accounts_receivable", + allocations=[ + PaymentAllocations( + id="123456", + type="invoice", + amount=49.99, + ), + ], + note="Some notes about this payment", + row_version="1-12345", + display_id="123456", + ) # Payment | + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + + # example passing only required values which don't have defaults set + try: + # Create Payment + api_response = api_instance.payments_add(payment) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling AccountingApi->payments_add: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Create Payment + api_response = api_instance.payments_add(payment, raw=raw, consumer_id=consumer_id, app_id=app_id, service_id=service_id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling AccountingApi->payments_add: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **payment** | [**Payment**](Payment.md)| | + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + +### Return type + +[**CreatePaymentResponse**](CreatePaymentResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**201** | Payment created | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **payments_all** +> GetPaymentsResponse payments_all() + +List Payments + +List Payments + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import accounting_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.get_payments_response import GetPaymentsResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = accounting_api.AccountingApi(api_client) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + cursor = "cursor_example" # str, none_type | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. (optional) + limit = 20 # int | Number of records to return (optional) if omitted the server will use the default value of 20 + + # example passing only required values which don't have defaults set + # and optional values + try: + # List Payments + api_response = api_instance.payments_all(raw=raw, consumer_id=consumer_id, app_id=app_id, service_id=service_id, cursor=cursor, limit=limit) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling AccountingApi->payments_all: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **cursor** | **str, none_type**| Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | [optional] + **limit** | **int**| Number of records to return | [optional] if omitted the server will use the default value of 20 + +### Return type + +[**GetPaymentsResponse**](GetPaymentsResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Payments | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **payments_delete** +> DeletePaymentResponse payments_delete(id) + +Delete Payment + +Delete Payment + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import accounting_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.delete_payment_response import DeletePaymentResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = accounting_api.AccountingApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # Delete Payment + api_response = api_instance.payments_delete(id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling AccountingApi->payments_delete: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Delete Payment + api_response = api_instance.payments_delete(id, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling AccountingApi->payments_delete: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + +### Return type + +[**DeletePaymentResponse**](DeletePaymentResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Payment deleted | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **payments_one** +> GetPaymentResponse payments_one(id) + +Get Payment + +Get Payment + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import accounting_api +from apideck.model.get_payment_response import GetPaymentResponse +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = accounting_api.AccountingApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # Get Payment + api_response = api_instance.payments_one(id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling AccountingApi->payments_one: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get Payment + api_response = api_instance.payments_one(id, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling AccountingApi->payments_one: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + +### Return type + +[**GetPaymentResponse**](GetPaymentResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Payment | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **payments_update** +> UpdatePaymentResponse payments_update(id, payment) + +Update Payment + +Update Payment + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import accounting_api +from apideck.model.update_payment_response import UpdatePaymentResponse +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.payment import Payment +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = accounting_api.AccountingApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + payment = Payment( + currency=Currency("USD"), + currency_rate=0.69, + total_amount=49.99, + reference="123456", + payment_method="Credit Card", + payment_method_reference="123456", + accounts_receivable_account_type="Account", + accounts_receivable_account_id="123456", + account=LinkedLedgerAccount( + id="123456", + nominal_code="N091", + code="453", + ), + transaction_date=dateutil_parser('2021-05-01T12:00:00Z'), + customer=LinkedCustomer( + id="12345", + display_name="Windsurf Shop", + name="Windsurf Shop", + ), + supplier=LinkedSupplier( + id="12345", + display_name="Windsurf Shop", + address=Address( + id="123", + type="primary", + string="25 Spring Street, Blackburn, VIC 3130", + name="HQ US", + line1="Main street", + line2="apt #", + line3="Suite #", + line4="delivery instructions", + street_number="25", + city="San Francisco", + state="CA", + postal_code="94104", + country="US", + latitude="40.759211", + longitude="-73.984638", + county="Santa Clara", + contact_name="Elon Musk", + salutation="Mr", + phone_number="111-111-1111", + fax="122-111-1111", + email="elon@musk.com", + website="https://elonmusk.com", + row_version="1-12345", + ), + ), + reconciled=True, + status="authorised", + type="accounts_receivable", + allocations=[ + PaymentAllocations( + id="123456", + type="invoice", + amount=49.99, + ), + ], + note="Some notes about this payment", + row_version="1-12345", + display_id="123456", + ) # Payment | + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # Update Payment + api_response = api_instance.payments_update(id, payment) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling AccountingApi->payments_update: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Update Payment + api_response = api_instance.payments_update(id, payment, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling AccountingApi->payments_update: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **payment** | [**Payment**](Payment.md)| | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + +### Return type + +[**UpdatePaymentResponse**](UpdatePaymentResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Payment Updated | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **profit_and_loss_one** +> GetProfitAndLossResponse profit_and_loss_one() + +Get Profit and Loss + +Get Profit and Loss + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import accounting_api +from apideck.model.profit_and_loss_filter import ProfitAndLossFilter +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.get_profit_and_loss_response import GetProfitAndLossResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = accounting_api.AccountingApi(api_client) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + filter = ProfitAndLossFilter( + customer_id="123abc", + start_date="2021-01-01", + end_date="2021-12-31", + ) # ProfitAndLossFilter | Apply filters (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get Profit and Loss + api_response = api_instance.profit_and_loss_one(raw=raw, consumer_id=consumer_id, app_id=app_id, service_id=service_id, filter=filter) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling AccountingApi->profit_and_loss_one: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **filter** | **ProfitAndLossFilter**| Apply filters | [optional] + +### Return type + +[**GetProfitAndLossResponse**](GetProfitAndLossResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Profit & Loss Report | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **suppliers_add** +> CreateSupplierResponse suppliers_add(supplier) + +Create Supplier + +Create Supplier + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import accounting_api +from apideck.model.create_supplier_response import CreateSupplierResponse +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.supplier import Supplier +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = accounting_api.AccountingApi(api_client) + supplier = Supplier( + company_name="SpaceX", + display_name="Windsurf Shop", + title="CEO", + first_name="Elon", + middle_name="D.", + last_name="Musk", + suffix="Jr.", + addresses=[ + Address( + id="123", + type="primary", + string="25 Spring Street, Blackburn, VIC 3130", + name="HQ US", + line1="Main street", + line2="apt #", + line3="Suite #", + line4="delivery instructions", + street_number="25", + city="San Francisco", + state="CA", + postal_code="94104", + country="US", + latitude="40.759211", + longitude="-73.984638", + county="Santa Clara", + contact_name="Elon Musk", + salutation="Mr", + phone_number="111-111-1111", + fax="122-111-1111", + email="elon@musk.com", + website="https://elonmusk.com", + row_version="1-12345", + ), + ], + notes="Some notes about this supplier", + phone_numbers=[ + PhoneNumber( + id="12345", + country_code="1", + area_code="323", + number="111-111-1111", + extension="105", + type="primary", + ), + ], + emails=[ + Email( + id="123", + email="elon@musk.com", + type="primary", + ), + ], + websites=[ + Website( + id="12345", + url="http://example.com", + type="primary", + ), + ], + bank_accounts=[ + BankAccount( + iban="CH2989144532982975332", + bic="AUDSCHGGXXX", + bsb_number="062-001", + branch_identifier="001", + bank_code="BNH", + account_number="123465", + account_name="SPACEX LLC", + account_type="credit_card", + currency=Currency("USD"), + ), + ], + tax_rate=LinkedTaxRate( + id="123456", + ), + tax_number="US123945459", + currency=Currency("USD"), + account=LinkedLedgerAccount( + id="123456", + nominal_code="N091", + code="453", + ), + status="active", + row_version="1-12345", + ) # Supplier | + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + + # example passing only required values which don't have defaults set + try: + # Create Supplier + api_response = api_instance.suppliers_add(supplier) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling AccountingApi->suppliers_add: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Create Supplier + api_response = api_instance.suppliers_add(supplier, raw=raw, consumer_id=consumer_id, app_id=app_id, service_id=service_id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling AccountingApi->suppliers_add: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **supplier** | [**Supplier**](Supplier.md)| | + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + +### Return type + +[**CreateSupplierResponse**](CreateSupplierResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**201** | Supplier created | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **suppliers_all** +> GetSuppliersResponse suppliers_all() + +List Suppliers + +List Suppliers + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import accounting_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.get_suppliers_response import GetSuppliersResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = accounting_api.AccountingApi(api_client) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + cursor = "cursor_example" # str, none_type | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. (optional) + limit = 20 # int | Number of records to return (optional) if omitted the server will use the default value of 20 + + # example passing only required values which don't have defaults set + # and optional values + try: + # List Suppliers + api_response = api_instance.suppliers_all(raw=raw, consumer_id=consumer_id, app_id=app_id, service_id=service_id, cursor=cursor, limit=limit) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling AccountingApi->suppliers_all: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **cursor** | **str, none_type**| Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | [optional] + **limit** | **int**| Number of records to return | [optional] if omitted the server will use the default value of 20 + +### Return type + +[**GetSuppliersResponse**](GetSuppliersResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Suppliers | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **suppliers_delete** +> DeleteSupplierResponse suppliers_delete(id) + +Delete Supplier + +Delete Supplier + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import accounting_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.delete_supplier_response import DeleteSupplierResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = accounting_api.AccountingApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # Delete Supplier + api_response = api_instance.suppliers_delete(id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling AccountingApi->suppliers_delete: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Delete Supplier + api_response = api_instance.suppliers_delete(id, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling AccountingApi->suppliers_delete: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + +### Return type + +[**DeleteSupplierResponse**](DeleteSupplierResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Supplier deleted | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **suppliers_one** +> GetSupplierResponse suppliers_one(id) + +Get Supplier + +Get Supplier + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import accounting_api +from apideck.model.get_supplier_response import GetSupplierResponse +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = accounting_api.AccountingApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # Get Supplier + api_response = api_instance.suppliers_one(id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling AccountingApi->suppliers_one: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get Supplier + api_response = api_instance.suppliers_one(id, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling AccountingApi->suppliers_one: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + +### Return type + +[**GetSupplierResponse**](GetSupplierResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Supplier | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **suppliers_update** +> UpdateSupplierResponse suppliers_update(id, supplier) + +Update Supplier + +Update Supplier + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import accounting_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.update_supplier_response import UpdateSupplierResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.supplier import Supplier +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = accounting_api.AccountingApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + supplier = Supplier( + company_name="SpaceX", + display_name="Windsurf Shop", + title="CEO", + first_name="Elon", + middle_name="D.", + last_name="Musk", + suffix="Jr.", + addresses=[ + Address( + id="123", + type="primary", + string="25 Spring Street, Blackburn, VIC 3130", + name="HQ US", + line1="Main street", + line2="apt #", + line3="Suite #", + line4="delivery instructions", + street_number="25", + city="San Francisco", + state="CA", + postal_code="94104", + country="US", + latitude="40.759211", + longitude="-73.984638", + county="Santa Clara", + contact_name="Elon Musk", + salutation="Mr", + phone_number="111-111-1111", + fax="122-111-1111", + email="elon@musk.com", + website="https://elonmusk.com", + row_version="1-12345", + ), + ], + notes="Some notes about this supplier", + phone_numbers=[ + PhoneNumber( + id="12345", + country_code="1", + area_code="323", + number="111-111-1111", + extension="105", + type="primary", + ), + ], + emails=[ + Email( + id="123", + email="elon@musk.com", + type="primary", + ), + ], + websites=[ + Website( + id="12345", + url="http://example.com", + type="primary", + ), + ], + bank_accounts=[ + BankAccount( + iban="CH2989144532982975332", + bic="AUDSCHGGXXX", + bsb_number="062-001", + branch_identifier="001", + bank_code="BNH", + account_number="123465", + account_name="SPACEX LLC", + account_type="credit_card", + currency=Currency("USD"), + ), + ], + tax_rate=LinkedTaxRate( + id="123456", + ), + tax_number="US123945459", + currency=Currency("USD"), + account=LinkedLedgerAccount( + id="123456", + nominal_code="N091", + code="453", + ), + status="active", + row_version="1-12345", + ) # Supplier | + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # Update Supplier + api_response = api_instance.suppliers_update(id, supplier) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling AccountingApi->suppliers_update: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Update Supplier + api_response = api_instance.suppliers_update(id, supplier, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling AccountingApi->suppliers_update: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **supplier** | [**Supplier**](Supplier.md)| | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + +### Return type + +[**UpdateSupplierResponse**](UpdateSupplierResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Supplier updated | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **tax_rates_add** +> CreateTaxRateResponse tax_rates_add(tax_rate) + +Create Tax Rate + +Create Tax Rate + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import accounting_api +from apideck.model.create_tax_rate_response import CreateTaxRateResponse +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.tax_rate import TaxRate +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = accounting_api.AccountingApi(api_client) + tax_rate = TaxRate( + id="1234", + name="GST on Purchases", + code="ABN", + description="Reduced rate GST Purchases", + effective_tax_rate=10, + total_tax_rate=10, + tax_payable_account_id="123456", + tax_remitted_account_id="123456", + components=[ + None, + ], + type="NONE", + report_tax_type="NONE", + original_tax_rate_id="12345", + status="active", + row_version="1-12345", + ) # TaxRate | + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + + # example passing only required values which don't have defaults set + try: + # Create Tax Rate + api_response = api_instance.tax_rates_add(tax_rate) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling AccountingApi->tax_rates_add: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Create Tax Rate + api_response = api_instance.tax_rates_add(tax_rate, raw=raw, consumer_id=consumer_id, app_id=app_id, service_id=service_id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling AccountingApi->tax_rates_add: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **tax_rate** | [**TaxRate**](TaxRate.md)| | + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + +### Return type + +[**CreateTaxRateResponse**](CreateTaxRateResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**201** | TaxRate created | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **tax_rates_all** +> GetTaxRatesResponse tax_rates_all() + +List Tax Rates + +List Tax Rates. Note: Not all connectors return the actual rate/percentage value. In this case, only the tax code or reference is returned. Connectors Affected: Quickbooks + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import accounting_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.get_tax_rates_response import GetTaxRatesResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.tax_rates_filter import TaxRatesFilter +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = accounting_api.AccountingApi(api_client) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + cursor = "cursor_example" # str, none_type | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. (optional) + limit = 20 # int | Number of records to return (optional) if omitted the server will use the default value of 20 + filter = TaxRatesFilter( + assets=True, + equity=True, + expenses=True, + liabilities=True, + revenue=True, + ) # TaxRatesFilter | Apply filters (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + # List Tax Rates + api_response = api_instance.tax_rates_all(raw=raw, consumer_id=consumer_id, app_id=app_id, service_id=service_id, cursor=cursor, limit=limit, filter=filter) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling AccountingApi->tax_rates_all: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **cursor** | **str, none_type**| Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | [optional] + **limit** | **int**| Number of records to return | [optional] if omitted the server will use the default value of 20 + **filter** | **TaxRatesFilter**| Apply filters | [optional] + +### Return type + +[**GetTaxRatesResponse**](GetTaxRatesResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | TaxRates | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **tax_rates_delete** +> DeleteTaxRateResponse tax_rates_delete(id) + +Delete Tax Rate + +Delete Tax Rate + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import accounting_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.delete_tax_rate_response import DeleteTaxRateResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = accounting_api.AccountingApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # Delete Tax Rate + api_response = api_instance.tax_rates_delete(id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling AccountingApi->tax_rates_delete: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Delete Tax Rate + api_response = api_instance.tax_rates_delete(id, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling AccountingApi->tax_rates_delete: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + +### Return type + +[**DeleteTaxRateResponse**](DeleteTaxRateResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | TaxRates deleted | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **tax_rates_one** +> GetTaxRateResponse tax_rates_one(id) + +Get Tax Rate + +Get Tax Rate. Note: Not all connectors return the actual rate/percentage value. In this case, only the tax code or reference is returned. Support will soon be added to return the actual rate/percentage by doing additional calls in the background to provide the full view of a given tax rate. Connectors Affected: Quickbooks + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import accounting_api +from apideck.model.get_tax_rate_response import GetTaxRateResponse +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = accounting_api.AccountingApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # Get Tax Rate + api_response = api_instance.tax_rates_one(id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling AccountingApi->tax_rates_one: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get Tax Rate + api_response = api_instance.tax_rates_one(id, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling AccountingApi->tax_rates_one: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + +### Return type + +[**GetTaxRateResponse**](GetTaxRateResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | TaxRate | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **tax_rates_update** +> UpdateTaxRateResponse tax_rates_update(id, tax_rate) + +Update Tax Rate + +Update Tax Rate + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import accounting_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.update_tax_rate_response import UpdateTaxRateResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.tax_rate import TaxRate +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = accounting_api.AccountingApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + tax_rate = TaxRate( + id="1234", + name="GST on Purchases", + code="ABN", + description="Reduced rate GST Purchases", + effective_tax_rate=10, + total_tax_rate=10, + tax_payable_account_id="123456", + tax_remitted_account_id="123456", + components=[ + None, + ], + type="NONE", + report_tax_type="NONE", + original_tax_rate_id="12345", + status="active", + row_version="1-12345", + ) # TaxRate | + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # Update Tax Rate + api_response = api_instance.tax_rates_update(id, tax_rate) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling AccountingApi->tax_rates_update: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Update Tax Rate + api_response = api_instance.tax_rates_update(id, tax_rate, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling AccountingApi->tax_rates_update: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **tax_rate** | [**TaxRate**](TaxRate.md)| | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + +### Return type + +[**UpdateTaxRateResponse**](UpdateTaxRateResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | TaxRate updated | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + diff --git a/docs/apis/Api.md b/docs/apis/Api.md new file mode 100644 index 0000000000..d26f2f7d6a --- /dev/null +++ b/docs/apis/Api.md @@ -0,0 +1,22 @@ +# Api + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | ID of the API. | [optional] [readonly] +**type** | **str** | Indicates whether the API is a Unified API. If unified_api is false, the API is a Platform API. | [optional] +**name** | **str** | Name of the API. | [optional] +**description** | **str, none_type** | Description of the API. | [optional] +**status** | [**ApiStatus**](ApiStatus.md) | | [optional] +**spec_url** | **str** | Link to the latest OpenAPI specification of the API. | [optional] +**api_reference_url** | **str** | Link to the API reference of the API. | [optional] +**postman_collection_id** | **str, none_type** | ID of the Postman collection of the API. | [optional] +**categories** | **[str]** | List of categories the API belongs to. | [optional] +**resources** | [**[ApiResources]**](ApiResources.md) | List of resources supported in this API. | [optional] +**events** | **[str]** | List of event types this API supports. | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/apis/AtsApi.md b/docs/apis/AtsApi.md new file mode 100644 index 0000000000..e3de17c558 --- /dev/null +++ b/docs/apis/AtsApi.md @@ -0,0 +1,625 @@ +# apideck.AtsApi + +All URIs are relative to *https://unify.apideck.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**applicants_add**](AtsApi.md#applicants_add) | **POST** /ats/applicants | Create applicant +[**applicants_all**](AtsApi.md#applicants_all) | **GET** /ats/applicants | List applicants +[**applicants_one**](AtsApi.md#applicants_one) | **GET** /ats/applicants/{id} | Get applicant +[**jobs_all**](AtsApi.md#jobs_all) | **GET** /ats/jobs | List Jobs +[**jobs_one**](AtsApi.md#jobs_one) | **GET** /ats/jobs/{id} | Get Job + + +# **applicants_add** +> CreateApplicantResponse applicants_add(applicant) + +Create applicant + +Create applicant + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import ats_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.create_applicant_response import CreateApplicantResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.applicant import Applicant +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = ats_api.AtsApi(api_client) + applicant = Applicant( + position_id="123", + name="Elon Musk", + first_name="Elon", + last_name="Musk", + middle_name="D.", + initials="EM", + birthday=dateutil_parser('Sat Aug 12 02:00:00 CEST 2000').date(), + cover_letter="I submit this application to express my sincere interest in the API developer position. In the previous role, I was responsible for leadership and ...", + photo_url="https://unavatar.io/elon-musk", + headline="PepsiCo, Inc, Central Perk", + title="CEO", + emails=[ + Email( + id="123", + email="elon@musk.com", + type="primary", + ), + ], + phone_numbers=[ + PhoneNumber( + id="12345", + country_code="1", + area_code="323", + number="111-111-1111", + extension="105", + type="primary", + ), + ], + addresses=[ + Address( + id="123", + type="primary", + string="25 Spring Street, Blackburn, VIC 3130", + name="HQ US", + line1="Main street", + line2="apt #", + line3="Suite #", + line4="delivery instructions", + street_number="25", + city="San Francisco", + state="CA", + postal_code="94104", + country="US", + latitude="40.759211", + longitude="-73.984638", + county="Santa Clara", + contact_name="Elon Musk", + salutation="Mr", + phone_number="111-111-1111", + fax="122-111-1111", + email="elon@musk.com", + website="https://elonmusk.com", + row_version="1-12345", + ), + ], + websites=[ + ApplicantWebsites( + id="12345", + url="http://example.com", + type="primary", + ), + ], + social_links=[ + ApplicantSocialLinks( + id="12345", + url="https://www.twitter.com/apideck-io", + type="twitter", + ), + ], + stage_id="12345", + recruiter_id="12345", + coordinator_id="12345", + applications=["a0d636c6-43b3-4bde-8c70-85b707d992f4","a98lfd96-43b3-4bde-8c70-85b707d992e6"], + followers=["a0d636c6-43b3-4bde-8c70-85b707d992f4","a98lfd96-43b3-4bde-8c70-85b707d992e6"], + sources=["Job site"], + confidential=False, + anonymized=True, + tags=Tags(["New"]), + archived=False, + owner_id="54321", + record_url="https://app.intercom.io/contacts/12345", + deleted=True, + ) # Applicant | + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + + # example passing only required values which don't have defaults set + try: + # Create applicant + api_response = api_instance.applicants_add(applicant) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling AtsApi->applicants_add: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Create applicant + api_response = api_instance.applicants_add(applicant, raw=raw, consumer_id=consumer_id, app_id=app_id, service_id=service_id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling AtsApi->applicants_add: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **applicant** | [**Applicant**](Applicant.md)| | + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + +### Return type + +[**CreateApplicantResponse**](CreateApplicantResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**201** | Applicants | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **applicants_all** +> GetApplicantsResponse applicants_all() + +List applicants + +List applicants + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import ats_api +from apideck.model.get_applicants_response import GetApplicantsResponse +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.jobs_filter import JobsFilter +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = ats_api.AtsApi(api_client) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + cursor = "cursor_example" # str, none_type | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. (optional) + limit = 20 # int | Number of records to return (optional) if omitted the server will use the default value of 20 + filter = JobsFilter( + job_id="1234", + ) # JobsFilter | Apply filters (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + # List applicants + api_response = api_instance.applicants_all(raw=raw, consumer_id=consumer_id, app_id=app_id, service_id=service_id, cursor=cursor, limit=limit, filter=filter) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling AtsApi->applicants_all: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **cursor** | **str, none_type**| Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | [optional] + **limit** | **int**| Number of records to return | [optional] if omitted the server will use the default value of 20 + **filter** | **JobsFilter**| Apply filters | [optional] + +### Return type + +[**GetApplicantsResponse**](GetApplicantsResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Applicants | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **applicants_one** +> GetApplicantResponse applicants_one(id) + +Get applicant + +Get applicant + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import ats_api +from apideck.model.get_applicant_response import GetApplicantResponse +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = ats_api.AtsApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # Get applicant + api_response = api_instance.applicants_one(id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling AtsApi->applicants_one: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get applicant + api_response = api_instance.applicants_one(id, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling AtsApi->applicants_one: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + +### Return type + +[**GetApplicantResponse**](GetApplicantResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Applicants | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **jobs_all** +> GetJobsResponse jobs_all() + +List Jobs + +List Jobs + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import ats_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.get_jobs_response import GetJobsResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = ats_api.AtsApi(api_client) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + cursor = "cursor_example" # str, none_type | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. (optional) + limit = 20 # int | Number of records to return (optional) if omitted the server will use the default value of 20 + + # example passing only required values which don't have defaults set + # and optional values + try: + # List Jobs + api_response = api_instance.jobs_all(raw=raw, consumer_id=consumer_id, app_id=app_id, service_id=service_id, cursor=cursor, limit=limit) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling AtsApi->jobs_all: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **cursor** | **str, none_type**| Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | [optional] + **limit** | **int**| Number of records to return | [optional] if omitted the server will use the default value of 20 + +### Return type + +[**GetJobsResponse**](GetJobsResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Jobs | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **jobs_one** +> GetJobResponse jobs_one(id) + +Get Job + +Get Job + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import ats_api +from apideck.model.get_job_response import GetJobResponse +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = ats_api.AtsApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # Get Job + api_response = api_instance.jobs_one(id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling AtsApi->jobs_one: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get Job + api_response = api_instance.jobs_one(id, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling AtsApi->jobs_one: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + +### Return type + +[**GetJobResponse**](GetJobResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Jobs | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + diff --git a/docs/apis/ConnectorApi.md b/docs/apis/ConnectorApi.md new file mode 100644 index 0000000000..77a6899661 --- /dev/null +++ b/docs/apis/ConnectorApi.md @@ -0,0 +1,801 @@ +# apideck.ConnectorApi + +All URIs are relative to *https://unify.apideck.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**api_resource_coverage_one**](ConnectorApi.md#api_resource_coverage_one) | **GET** /connector/apis/{id}/resources/{resource_id}/coverage | Get API Resource Coverage +[**api_resources_one**](ConnectorApi.md#api_resources_one) | **GET** /connector/apis/{id}/resources/{resource_id} | Get API Resource +[**apis_all**](ConnectorApi.md#apis_all) | **GET** /connector/apis | List APIs +[**apis_one**](ConnectorApi.md#apis_one) | **GET** /connector/apis/{id} | Get API +[**connector_docs_one**](ConnectorApi.md#connector_docs_one) | **GET** /connector/connectors/{id}/docs/{doc_id} | Get Connector Doc content +[**connector_resources_one**](ConnectorApi.md#connector_resources_one) | **GET** /connector/connectors/{id}/resources/{resource_id} | Get Connector Resource +[**connectors_all**](ConnectorApi.md#connectors_all) | **GET** /connector/connectors | List Connectors +[**connectors_one**](ConnectorApi.md#connectors_one) | **GET** /connector/connectors/{id} | Get Connector + + +# **api_resource_coverage_one** +> GetApiResourceCoverageResponse api_resource_coverage_one(id, resource_id) + +Get API Resource Coverage + +Get API Resource Coverage + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import connector_api +from apideck.model.get_api_resource_coverage_response import GetApiResourceCoverageResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = connector_api.ConnectorApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + resource_id = "resource_id_example" # str | ID of the resource you are acting upon. + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + + # example passing only required values which don't have defaults set + try: + # Get API Resource Coverage + api_response = api_instance.api_resource_coverage_one(id, resource_id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling ConnectorApi->api_resource_coverage_one: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get API Resource Coverage + api_response = api_instance.api_resource_coverage_one(id, resource_id, app_id=app_id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling ConnectorApi->api_resource_coverage_one: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **resource_id** | **str**| ID of the resource you are acting upon. | + **app_id** | **str**| The ID of your Unify application | [optional] + +### Return type + +[**GetApiResourceCoverageResponse**](GetApiResourceCoverageResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | ApiResources | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **api_resources_one** +> GetApiResourceResponse api_resources_one(id, resource_id) + +Get API Resource + +Get API Resource + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import connector_api +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.get_api_resource_response import GetApiResourceResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = connector_api.ConnectorApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + resource_id = "resource_id_example" # str | ID of the resource you are acting upon. + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + + # example passing only required values which don't have defaults set + try: + # Get API Resource + api_response = api_instance.api_resources_one(id, resource_id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling ConnectorApi->api_resources_one: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get API Resource + api_response = api_instance.api_resources_one(id, resource_id, app_id=app_id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling ConnectorApi->api_resources_one: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **resource_id** | **str**| ID of the resource you are acting upon. | + **app_id** | **str**| The ID of your Unify application | [optional] + +### Return type + +[**GetApiResourceResponse**](GetApiResourceResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | ApiResources | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **apis_all** +> GetApisResponse apis_all() + +List APIs + +List APIs + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import connector_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.apis_filter import ApisFilter +from apideck.model.get_apis_response import GetApisResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = connector_api.ConnectorApi(api_client) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + cursor = "cursor_example" # str, none_type | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. (optional) + limit = 20 # int | Number of records to return (optional) if omitted the server will use the default value of 20 + filter = ApisFilter( + status=ApiStatus("live"), + ) # ApisFilter | Apply filters (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + # List APIs + api_response = api_instance.apis_all(app_id=app_id, cursor=cursor, limit=limit, filter=filter) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling ConnectorApi->apis_all: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **app_id** | **str**| The ID of your Unify application | [optional] + **cursor** | **str, none_type**| Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | [optional] + **limit** | **int**| Number of records to return | [optional] if omitted the server will use the default value of 20 + **filter** | **ApisFilter**| Apply filters | [optional] + +### Return type + +[**GetApisResponse**](GetApisResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Apis | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **apis_one** +> GetApiResponse apis_one(id) + +Get API + +Get API + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import connector_api +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.get_api_response import GetApiResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = connector_api.ConnectorApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + + # example passing only required values which don't have defaults set + try: + # Get API + api_response = api_instance.apis_one(id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling ConnectorApi->apis_one: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get API + api_response = api_instance.apis_one(id, app_id=app_id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling ConnectorApi->apis_one: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **app_id** | **str**| The ID of your Unify application | [optional] + +### Return type + +[**GetApiResponse**](GetApiResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Apis | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **connector_docs_one** +> str connector_docs_one(id, doc_id) + +Get Connector Doc content + +Get Connector Doc content + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import connector_api +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = connector_api.ConnectorApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + doc_id = "doc_id_example" # str | ID of the Doc + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + + # example passing only required values which don't have defaults set + try: + # Get Connector Doc content + api_response = api_instance.connector_docs_one(id, doc_id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling ConnectorApi->connector_docs_one: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get Connector Doc content + api_response = api_instance.connector_docs_one(id, doc_id, app_id=app_id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling ConnectorApi->connector_docs_one: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **doc_id** | **str**| ID of the Doc | + **app_id** | **str**| The ID of your Unify application | [optional] + +### Return type + +**str** + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: text/markdown, application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Connectors | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **connector_resources_one** +> GetConnectorResourceResponse connector_resources_one(id, resource_id) + +Get Connector Resource + +Get Connector Resource + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import connector_api +from apideck.model.get_connector_resource_response import GetConnectorResourceResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unified_api_id import UnifiedApiId +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = connector_api.ConnectorApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + resource_id = "resource_id_example" # str | ID of the resource you are acting upon. + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + unified_api = UnifiedApiId("crm") # UnifiedApiId | Specify unified API for the connector resource. This is useful when a resource appears in multiple APIs (optional) + + # example passing only required values which don't have defaults set + try: + # Get Connector Resource + api_response = api_instance.connector_resources_one(id, resource_id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling ConnectorApi->connector_resources_one: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get Connector Resource + api_response = api_instance.connector_resources_one(id, resource_id, app_id=app_id, unified_api=unified_api) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling ConnectorApi->connector_resources_one: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **resource_id** | **str**| ID of the resource you are acting upon. | + **app_id** | **str**| The ID of your Unify application | [optional] + **unified_api** | **UnifiedApiId**| Specify unified API for the connector resource. This is useful when a resource appears in multiple APIs | [optional] + +### Return type + +[**GetConnectorResourceResponse**](GetConnectorResourceResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | ConnectorResources | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **connectors_all** +> GetConnectorsResponse connectors_all() + +List Connectors + +List Connectors + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import connector_api +from apideck.model.connectors_filter import ConnectorsFilter +from apideck.model.get_connectors_response import GetConnectorsResponse +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = connector_api.ConnectorApi(api_client) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + cursor = "cursor_example" # str, none_type | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. (optional) + limit = 20 # int | Number of records to return (optional) if omitted the server will use the default value of 20 + filter = ConnectorsFilter( + unified_api=UnifiedApiId("crm"), + status=ConnectorStatus("live"), + ) # ConnectorsFilter | Apply filters (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + # List Connectors + api_response = api_instance.connectors_all(app_id=app_id, cursor=cursor, limit=limit, filter=filter) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling ConnectorApi->connectors_all: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **app_id** | **str**| The ID of your Unify application | [optional] + **cursor** | **str, none_type**| Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | [optional] + **limit** | **int**| Number of records to return | [optional] if omitted the server will use the default value of 20 + **filter** | **ConnectorsFilter**| Apply filters | [optional] + +### Return type + +[**GetConnectorsResponse**](GetConnectorsResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Connectors | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **connectors_one** +> GetConnectorResponse connectors_one(id) + +Get Connector + +Get Connector + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import connector_api +from apideck.model.get_connector_response import GetConnectorResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = connector_api.ConnectorApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + + # example passing only required values which don't have defaults set + try: + # Get Connector + api_response = api_instance.connectors_one(id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling ConnectorApi->connectors_one: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get Connector + api_response = api_instance.connectors_one(id, app_id=app_id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling ConnectorApi->connectors_one: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **app_id** | **str**| The ID of your Unify application | [optional] + +### Return type + +[**GetConnectorResponse**](GetConnectorResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Connectors | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + diff --git a/docs/apis/CrmApi.md b/docs/apis/CrmApi.md new file mode 100644 index 0000000000..6934829eda --- /dev/null +++ b/docs/apis/CrmApi.md @@ -0,0 +1,5346 @@ +# apideck.CrmApi + +All URIs are relative to *https://unify.apideck.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**activities_add**](CrmApi.md#activities_add) | **POST** /crm/activities | Create activity +[**activities_all**](CrmApi.md#activities_all) | **GET** /crm/activities | List activities +[**activities_delete**](CrmApi.md#activities_delete) | **DELETE** /crm/activities/{id} | Delete activity +[**activities_one**](CrmApi.md#activities_one) | **GET** /crm/activities/{id} | Get activity +[**activities_update**](CrmApi.md#activities_update) | **PATCH** /crm/activities/{id} | Update activity +[**companies_add**](CrmApi.md#companies_add) | **POST** /crm/companies | Create company +[**companies_all**](CrmApi.md#companies_all) | **GET** /crm/companies | List companies +[**companies_delete**](CrmApi.md#companies_delete) | **DELETE** /crm/companies/{id} | Delete company +[**companies_one**](CrmApi.md#companies_one) | **GET** /crm/companies/{id} | Get company +[**companies_update**](CrmApi.md#companies_update) | **PATCH** /crm/companies/{id} | Update company +[**contacts_add**](CrmApi.md#contacts_add) | **POST** /crm/contacts | Create contact +[**contacts_all**](CrmApi.md#contacts_all) | **GET** /crm/contacts | List contacts +[**contacts_delete**](CrmApi.md#contacts_delete) | **DELETE** /crm/contacts/{id} | Delete contact +[**contacts_one**](CrmApi.md#contacts_one) | **GET** /crm/contacts/{id} | Get contact +[**contacts_update**](CrmApi.md#contacts_update) | **PATCH** /crm/contacts/{id} | Update contact +[**leads_add**](CrmApi.md#leads_add) | **POST** /crm/leads | Create lead +[**leads_all**](CrmApi.md#leads_all) | **GET** /crm/leads | List leads +[**leads_delete**](CrmApi.md#leads_delete) | **DELETE** /crm/leads/{id} | Delete lead +[**leads_one**](CrmApi.md#leads_one) | **GET** /crm/leads/{id} | Get lead +[**leads_update**](CrmApi.md#leads_update) | **PATCH** /crm/leads/{id} | Update lead +[**notes_add**](CrmApi.md#notes_add) | **POST** /crm/notes | Create note +[**notes_all**](CrmApi.md#notes_all) | **GET** /crm/notes | List notes +[**notes_delete**](CrmApi.md#notes_delete) | **DELETE** /crm/notes/{id} | Delete note +[**notes_one**](CrmApi.md#notes_one) | **GET** /crm/notes/{id} | Get note +[**notes_update**](CrmApi.md#notes_update) | **PATCH** /crm/notes/{id} | Update note +[**opportunities_add**](CrmApi.md#opportunities_add) | **POST** /crm/opportunities | Create opportunity +[**opportunities_all**](CrmApi.md#opportunities_all) | **GET** /crm/opportunities | List opportunities +[**opportunities_delete**](CrmApi.md#opportunities_delete) | **DELETE** /crm/opportunities/{id} | Delete opportunity +[**opportunities_one**](CrmApi.md#opportunities_one) | **GET** /crm/opportunities/{id} | Get opportunity +[**opportunities_update**](CrmApi.md#opportunities_update) | **PATCH** /crm/opportunities/{id} | Update opportunity +[**pipelines_add**](CrmApi.md#pipelines_add) | **POST** /crm/pipelines | Create pipeline +[**pipelines_all**](CrmApi.md#pipelines_all) | **GET** /crm/pipelines | List pipelines +[**pipelines_delete**](CrmApi.md#pipelines_delete) | **DELETE** /crm/pipelines/{id} | Delete pipeline +[**pipelines_one**](CrmApi.md#pipelines_one) | **GET** /crm/pipelines/{id} | Get pipeline +[**pipelines_update**](CrmApi.md#pipelines_update) | **PATCH** /crm/pipelines/{id} | Update pipeline +[**users_add**](CrmApi.md#users_add) | **POST** /crm/users | Create user +[**users_all**](CrmApi.md#users_all) | **GET** /crm/users | List users +[**users_delete**](CrmApi.md#users_delete) | **DELETE** /crm/users/{id} | Delete user +[**users_one**](CrmApi.md#users_one) | **GET** /crm/users/{id} | Get user +[**users_update**](CrmApi.md#users_update) | **PATCH** /crm/users/{id} | Update user + + +# **activities_add** +> CreateActivityResponse activities_add(activity) + +Create activity + +Create activity + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import crm_api +from apideck.model.create_activity_response import CreateActivityResponse +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.activity import Activity +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = crm_api.CrmApi(api_client) + activity = Activity( + activity_datetime="2021-05-01T12:00:00.000Z", + duration_seconds=1800, + user_id="12345", + account_id="12345", + contact_id="12345", + company_id="12345", + opportunity_id="12345", + lead_id="12345", + owner_id="12345", + campaign_id="12345", + case_id="12345", + asset_id="12345", + contract_id="12345", + product_id="12345", + solution_id="12345", + custom_object_id="12345", + type="meeting", + title="Meeting", + description="More info about the meeting", + note="An internal note about the meeting", + location="Space", + location_address=Address( + id="123", + type="primary", + string="25 Spring Street, Blackburn, VIC 3130", + name="HQ US", + line1="Main street", + line2="apt #", + line3="Suite #", + line4="delivery instructions", + street_number="25", + city="San Francisco", + state="CA", + postal_code="94104", + country="US", + latitude="40.759211", + longitude="-73.984638", + county="Santa Clara", + contact_name="Elon Musk", + salutation="Mr", + phone_number="111-111-1111", + fax="122-111-1111", + email="elon@musk.com", + website="https://elonmusk.com", + row_version="1-12345", + ), + all_day_event=False, + private=True, + group_event=True, + event_sub_type="debrief", + group_event_type="Proposed", + child=False, + archived=False, + deleted=False, + show_as="busy", + done=False, + start_datetime="2021-05-01T12:00:00.000Z", + end_datetime="2021-05-01T12:30:00.000Z", + activity_date="2021-05-01", + end_date="2021-05-01", + recurrent=False, + reminder_datetime="2021-05-01T17:00:00.000Z", + reminder_set=False, + video_conference_url="https://us02web.zoom.us/j/88120759396", + video_conference_id="zoom:88120759396", + custom_fields=[ + CustomField( + id="2389328923893298", + name="employee_level", + description="Employee Level", + value=None, + ), + ], + attendees=[ + ActivityAttendee( + name="Elon Musk", + first_name="Elon", + middle_name="D.", + last_name="Musk", + prefix="Mr.", + suffix="PhD", + email_address="elon@musk.com", + is_organizer=True, + status="accepted", + ), + ], + ) # Activity | + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + + # example passing only required values which don't have defaults set + try: + # Create activity + api_response = api_instance.activities_add(activity) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling CrmApi->activities_add: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Create activity + api_response = api_instance.activities_add(activity, raw=raw, consumer_id=consumer_id, app_id=app_id, service_id=service_id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling CrmApi->activities_add: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **activity** | [**Activity**](Activity.md)| | + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + +### Return type + +[**CreateActivityResponse**](CreateActivityResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**201** | Activity created | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **activities_all** +> GetActivitiesResponse activities_all() + +List activities + +List activities + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import crm_api +from apideck.model.get_activities_response import GetActivitiesResponse +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = crm_api.CrmApi(api_client) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + cursor = "cursor_example" # str, none_type | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. (optional) + limit = 20 # int | Number of records to return (optional) if omitted the server will use the default value of 20 + + # example passing only required values which don't have defaults set + # and optional values + try: + # List activities + api_response = api_instance.activities_all(raw=raw, consumer_id=consumer_id, app_id=app_id, service_id=service_id, cursor=cursor, limit=limit) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling CrmApi->activities_all: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **cursor** | **str, none_type**| Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | [optional] + **limit** | **int**| Number of records to return | [optional] if omitted the server will use the default value of 20 + +### Return type + +[**GetActivitiesResponse**](GetActivitiesResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Activities | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **activities_delete** +> DeleteActivityResponse activities_delete(id) + +Delete activity + +Delete activity + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import crm_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.delete_activity_response import DeleteActivityResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = crm_api.CrmApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # Delete activity + api_response = api_instance.activities_delete(id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling CrmApi->activities_delete: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Delete activity + api_response = api_instance.activities_delete(id, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling CrmApi->activities_delete: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + +### Return type + +[**DeleteActivityResponse**](DeleteActivityResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Activity deleted | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **activities_one** +> GetActivityResponse activities_one(id) + +Get activity + +Get activity + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import crm_api +from apideck.model.get_activity_response import GetActivityResponse +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = crm_api.CrmApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # Get activity + api_response = api_instance.activities_one(id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling CrmApi->activities_one: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get activity + api_response = api_instance.activities_one(id, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling CrmApi->activities_one: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + +### Return type + +[**GetActivityResponse**](GetActivityResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Activity | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **activities_update** +> UpdateActivityResponse activities_update(id, activity) + +Update activity + +Update activity + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import crm_api +from apideck.model.update_activity_response import UpdateActivityResponse +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.activity import Activity +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = crm_api.CrmApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + activity = Activity( + activity_datetime="2021-05-01T12:00:00.000Z", + duration_seconds=1800, + user_id="12345", + account_id="12345", + contact_id="12345", + company_id="12345", + opportunity_id="12345", + lead_id="12345", + owner_id="12345", + campaign_id="12345", + case_id="12345", + asset_id="12345", + contract_id="12345", + product_id="12345", + solution_id="12345", + custom_object_id="12345", + type="meeting", + title="Meeting", + description="More info about the meeting", + note="An internal note about the meeting", + location="Space", + location_address=Address( + id="123", + type="primary", + string="25 Spring Street, Blackburn, VIC 3130", + name="HQ US", + line1="Main street", + line2="apt #", + line3="Suite #", + line4="delivery instructions", + street_number="25", + city="San Francisco", + state="CA", + postal_code="94104", + country="US", + latitude="40.759211", + longitude="-73.984638", + county="Santa Clara", + contact_name="Elon Musk", + salutation="Mr", + phone_number="111-111-1111", + fax="122-111-1111", + email="elon@musk.com", + website="https://elonmusk.com", + row_version="1-12345", + ), + all_day_event=False, + private=True, + group_event=True, + event_sub_type="debrief", + group_event_type="Proposed", + child=False, + archived=False, + deleted=False, + show_as="busy", + done=False, + start_datetime="2021-05-01T12:00:00.000Z", + end_datetime="2021-05-01T12:30:00.000Z", + activity_date="2021-05-01", + end_date="2021-05-01", + recurrent=False, + reminder_datetime="2021-05-01T17:00:00.000Z", + reminder_set=False, + video_conference_url="https://us02web.zoom.us/j/88120759396", + video_conference_id="zoom:88120759396", + custom_fields=[ + CustomField( + id="2389328923893298", + name="employee_level", + description="Employee Level", + value=None, + ), + ], + attendees=[ + ActivityAttendee( + name="Elon Musk", + first_name="Elon", + middle_name="D.", + last_name="Musk", + prefix="Mr.", + suffix="PhD", + email_address="elon@musk.com", + is_organizer=True, + status="accepted", + ), + ], + ) # Activity | + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # Update activity + api_response = api_instance.activities_update(id, activity) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling CrmApi->activities_update: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Update activity + api_response = api_instance.activities_update(id, activity, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling CrmApi->activities_update: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **activity** | [**Activity**](Activity.md)| | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + +### Return type + +[**UpdateActivityResponse**](UpdateActivityResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Activity updated | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **companies_add** +> CreateCompanyResponse companies_add(company) + +Create company + +Create company + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import crm_api +from apideck.model.create_company_response import CreateCompanyResponse +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.company import Company +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = crm_api.CrmApi(api_client) + company = Company( + name="SpaceX", + owner_id="12345", + image="https://www.spacex.com/static/images/share.jpg", + description="Space Exploration Technologies Corp. is an American aerospace manufacturer, space transportation services and communications company headquartered in Hawthorne, California.", + vat_number="BE0689615164", + currency=Currency("USD"), + status="Open", + fax="+12129876543", + annual_revenue="+$35m", + number_of_employees="500-1000", + industry="Apparel", + ownership="Public", + sales_tax_number="12456EN", + payee_number="78932EN", + abn_or_tfn="46 115 614 695", + abn_branch="123", + acn="XXX XXX XXX", + first_name="Elon", + last_name="Musk", + bank_accounts=[ + BankAccount( + iban="CH2989144532982975332", + bic="AUDSCHGGXXX", + bsb_number="062-001", + branch_identifier="001", + bank_code="BNH", + account_number="123465", + account_name="SPACEX LLC", + account_type="credit_card", + currency=Currency("USD"), + ), + ], + websites=[ + Website( + id="12345", + url="http://example.com", + type="primary", + ), + ], + addresses=[ + Address( + id="123", + type="primary", + string="25 Spring Street, Blackburn, VIC 3130", + name="HQ US", + line1="Main street", + line2="apt #", + line3="Suite #", + line4="delivery instructions", + street_number="25", + city="San Francisco", + state="CA", + postal_code="94104", + country="US", + latitude="40.759211", + longitude="-73.984638", + county="Santa Clara", + contact_name="Elon Musk", + salutation="Mr", + phone_number="111-111-1111", + fax="122-111-1111", + email="elon@musk.com", + website="https://elonmusk.com", + row_version="1-12345", + ), + ], + social_links=[ + SocialLink( + id="12345", + url="https://www.twitter.com/apideck-io", + type="twitter", + ), + ], + phone_numbers=[ + PhoneNumber( + id="12345", + country_code="1", + area_code="323", + number="111-111-1111", + extension="105", + type="primary", + ), + ], + emails=[ + Email( + id="123", + email="elon@musk.com", + type="primary", + ), + ], + row_type=CompanyRowType( + id="12345", + name="Customer Account", + ), + custom_fields=[ + CustomField( + id="2389328923893298", + name="employee_level", + description="Employee Level", + value=None, + ), + ], + tags=Tags(["New"]), + read_only=False, + salutation="Mr", + birthday=dateutil_parser('Sat Aug 12 02:00:00 CEST 2000').date(), + ) # Company | + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + + # example passing only required values which don't have defaults set + try: + # Create company + api_response = api_instance.companies_add(company) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling CrmApi->companies_add: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Create company + api_response = api_instance.companies_add(company, raw=raw, consumer_id=consumer_id, app_id=app_id, service_id=service_id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling CrmApi->companies_add: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **company** | [**Company**](Company.md)| | + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + +### Return type + +[**CreateCompanyResponse**](CreateCompanyResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**201** | Company created | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **companies_all** +> GetCompaniesResponse companies_all() + +List companies + +List companies + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import crm_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.companies_sort import CompaniesSort +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.get_companies_response import GetCompaniesResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.companies_filter import CompaniesFilter +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = crm_api.CrmApi(api_client) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + cursor = "cursor_example" # str, none_type | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. (optional) + limit = 20 # int | Number of records to return (optional) if omitted the server will use the default value of 20 + filter = CompaniesFilter( + name="SpaceX", + ) # CompaniesFilter | Apply filters (optional) + sort = CompaniesSort( + by="created_at", + direction=SortDirection("asc"), + ) # CompaniesSort | Apply sorting (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + # List companies + api_response = api_instance.companies_all(raw=raw, consumer_id=consumer_id, app_id=app_id, service_id=service_id, cursor=cursor, limit=limit, filter=filter, sort=sort) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling CrmApi->companies_all: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **cursor** | **str, none_type**| Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | [optional] + **limit** | **int**| Number of records to return | [optional] if omitted the server will use the default value of 20 + **filter** | **CompaniesFilter**| Apply filters | [optional] + **sort** | **CompaniesSort**| Apply sorting | [optional] + +### Return type + +[**GetCompaniesResponse**](GetCompaniesResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Companies | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **companies_delete** +> DeleteCompanyResponse companies_delete(id) + +Delete company + +Delete company + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import crm_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.delete_company_response import DeleteCompanyResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = crm_api.CrmApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + + # example passing only required values which don't have defaults set + try: + # Delete company + api_response = api_instance.companies_delete(id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling CrmApi->companies_delete: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Delete company + api_response = api_instance.companies_delete(id, raw=raw, consumer_id=consumer_id, app_id=app_id, service_id=service_id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling CrmApi->companies_delete: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + +### Return type + +[**DeleteCompanyResponse**](DeleteCompanyResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Company deleted | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **companies_one** +> GetCompanyResponse companies_one(id) + +Get company + +Get company + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import crm_api +from apideck.model.get_company_response import GetCompanyResponse +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = crm_api.CrmApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + + # example passing only required values which don't have defaults set + try: + # Get company + api_response = api_instance.companies_one(id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling CrmApi->companies_one: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get company + api_response = api_instance.companies_one(id, raw=raw, consumer_id=consumer_id, app_id=app_id, service_id=service_id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling CrmApi->companies_one: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + +### Return type + +[**GetCompanyResponse**](GetCompanyResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Company | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **companies_update** +> UpdateCompanyResponse companies_update(id, company) + +Update company + +Update company + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import crm_api +from apideck.model.update_company_response import UpdateCompanyResponse +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.company import Company +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = crm_api.CrmApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + company = Company( + name="SpaceX", + owner_id="12345", + image="https://www.spacex.com/static/images/share.jpg", + description="Space Exploration Technologies Corp. is an American aerospace manufacturer, space transportation services and communications company headquartered in Hawthorne, California.", + vat_number="BE0689615164", + currency=Currency("USD"), + status="Open", + fax="+12129876543", + annual_revenue="+$35m", + number_of_employees="500-1000", + industry="Apparel", + ownership="Public", + sales_tax_number="12456EN", + payee_number="78932EN", + abn_or_tfn="46 115 614 695", + abn_branch="123", + acn="XXX XXX XXX", + first_name="Elon", + last_name="Musk", + bank_accounts=[ + BankAccount( + iban="CH2989144532982975332", + bic="AUDSCHGGXXX", + bsb_number="062-001", + branch_identifier="001", + bank_code="BNH", + account_number="123465", + account_name="SPACEX LLC", + account_type="credit_card", + currency=Currency("USD"), + ), + ], + websites=[ + Website( + id="12345", + url="http://example.com", + type="primary", + ), + ], + addresses=[ + Address( + id="123", + type="primary", + string="25 Spring Street, Blackburn, VIC 3130", + name="HQ US", + line1="Main street", + line2="apt #", + line3="Suite #", + line4="delivery instructions", + street_number="25", + city="San Francisco", + state="CA", + postal_code="94104", + country="US", + latitude="40.759211", + longitude="-73.984638", + county="Santa Clara", + contact_name="Elon Musk", + salutation="Mr", + phone_number="111-111-1111", + fax="122-111-1111", + email="elon@musk.com", + website="https://elonmusk.com", + row_version="1-12345", + ), + ], + social_links=[ + SocialLink( + id="12345", + url="https://www.twitter.com/apideck-io", + type="twitter", + ), + ], + phone_numbers=[ + PhoneNumber( + id="12345", + country_code="1", + area_code="323", + number="111-111-1111", + extension="105", + type="primary", + ), + ], + emails=[ + Email( + id="123", + email="elon@musk.com", + type="primary", + ), + ], + row_type=CompanyRowType( + id="12345", + name="Customer Account", + ), + custom_fields=[ + CustomField( + id="2389328923893298", + name="employee_level", + description="Employee Level", + value=None, + ), + ], + tags=Tags(["New"]), + read_only=False, + salutation="Mr", + birthday=dateutil_parser('Sat Aug 12 02:00:00 CEST 2000').date(), + ) # Company | + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + + # example passing only required values which don't have defaults set + try: + # Update company + api_response = api_instance.companies_update(id, company) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling CrmApi->companies_update: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Update company + api_response = api_instance.companies_update(id, company, raw=raw, consumer_id=consumer_id, app_id=app_id, service_id=service_id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling CrmApi->companies_update: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **company** | [**Company**](Company.md)| | + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + +### Return type + +[**UpdateCompanyResponse**](UpdateCompanyResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Company updated | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **contacts_add** +> CreateContactResponse contacts_add(contact) + +Create contact + +Create contact + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import crm_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.create_contact_response import CreateContactResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.contact import Contact +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = crm_api.CrmApi(api_client) + contact = Contact( + name="Elon Musk", + owner_id="54321", + type="personal", + company_id="23456", + company_name="23456", + lead_id="34567", + first_name="Elon", + middle_name="D.", + last_name="Musk", + prefix="Mr.", + suffix="PhD", + title="CEO", + department="Engineering", + language="EN", + gender="female", + birthday="2000-08-12", + image="https://unavatar.io/elon-musk", + photo_url="https://unavatar.io/elon-musk", + lead_source="Cold Call", + fax="+12129876543", + description="Internal champion", + current_balance=10.5, + status="open", + active=True, + websites=[ + Website( + id="12345", + url="http://example.com", + type="primary", + ), + ], + addresses=[ + Address( + id="123", + type="primary", + string="25 Spring Street, Blackburn, VIC 3130", + name="HQ US", + line1="Main street", + line2="apt #", + line3="Suite #", + line4="delivery instructions", + street_number="25", + city="San Francisco", + state="CA", + postal_code="94104", + country="US", + latitude="40.759211", + longitude="-73.984638", + county="Santa Clara", + contact_name="Elon Musk", + salutation="Mr", + phone_number="111-111-1111", + fax="122-111-1111", + email="elon@musk.com", + website="https://elonmusk.com", + row_version="1-12345", + ), + ], + social_links=[ + SocialLink( + id="12345", + url="https://www.twitter.com/apideck-io", + type="twitter", + ), + ], + phone_numbers=[ + PhoneNumber( + id="12345", + country_code="1", + area_code="323", + number="111-111-1111", + extension="105", + type="primary", + ), + ], + emails=[ + Email( + id="123", + email="elon@musk.com", + type="primary", + ), + ], + email_domain="gmail.com", + custom_fields=[ + CustomField( + id="2389328923893298", + name="employee_level", + description="Employee Level", + value=None, + ), + ], + tags=Tags(["New"]), + ) # Contact | + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + + # example passing only required values which don't have defaults set + try: + # Create contact + api_response = api_instance.contacts_add(contact) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling CrmApi->contacts_add: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Create contact + api_response = api_instance.contacts_add(contact, raw=raw, consumer_id=consumer_id, app_id=app_id, service_id=service_id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling CrmApi->contacts_add: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **contact** | [**Contact**](Contact.md)| | + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + +### Return type + +[**CreateContactResponse**](CreateContactResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**201** | Contact created | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **contacts_all** +> GetContactsResponse contacts_all() + +List contacts + +List contacts + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import crm_api +from apideck.model.get_contacts_response import GetContactsResponse +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.contacts_sort import ContactsSort +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.contacts_filter import ContactsFilter +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = crm_api.CrmApi(api_client) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + cursor = "cursor_example" # str, none_type | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. (optional) + limit = 20 # int | Number of records to return (optional) if omitted the server will use the default value of 20 + filter = ContactsFilter( + name="Elon Musk", + first_name="Elon", + last_name="Musk", + email="elon@tesla.com", + ) # ContactsFilter | Apply filters (optional) + sort = ContactsSort( + by="created_at", + direction=SortDirection("asc"), + ) # ContactsSort | Apply sorting (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + # List contacts + api_response = api_instance.contacts_all(raw=raw, consumer_id=consumer_id, app_id=app_id, service_id=service_id, cursor=cursor, limit=limit, filter=filter, sort=sort) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling CrmApi->contacts_all: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **cursor** | **str, none_type**| Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | [optional] + **limit** | **int**| Number of records to return | [optional] if omitted the server will use the default value of 20 + **filter** | **ContactsFilter**| Apply filters | [optional] + **sort** | **ContactsSort**| Apply sorting | [optional] + +### Return type + +[**GetContactsResponse**](GetContactsResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Contacts | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **contacts_delete** +> DeleteContactResponse contacts_delete(id) + +Delete contact + +Delete contact + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import crm_api +from apideck.model.delete_contact_response import DeleteContactResponse +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = crm_api.CrmApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # Delete contact + api_response = api_instance.contacts_delete(id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling CrmApi->contacts_delete: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Delete contact + api_response = api_instance.contacts_delete(id, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling CrmApi->contacts_delete: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + +### Return type + +[**DeleteContactResponse**](DeleteContactResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Contact deleted | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **contacts_one** +> GetContactResponse contacts_one(id) + +Get contact + +Get contact + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import crm_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.get_contact_response import GetContactResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = crm_api.CrmApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # Get contact + api_response = api_instance.contacts_one(id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling CrmApi->contacts_one: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get contact + api_response = api_instance.contacts_one(id, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling CrmApi->contacts_one: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + +### Return type + +[**GetContactResponse**](GetContactResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Contact | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **contacts_update** +> UpdateContactResponse contacts_update(id, contact) + +Update contact + +Update contact + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import crm_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.update_contact_response import UpdateContactResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.contact import Contact +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = crm_api.CrmApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + contact = Contact( + name="Elon Musk", + owner_id="54321", + type="personal", + company_id="23456", + company_name="23456", + lead_id="34567", + first_name="Elon", + middle_name="D.", + last_name="Musk", + prefix="Mr.", + suffix="PhD", + title="CEO", + department="Engineering", + language="EN", + gender="female", + birthday="2000-08-12", + image="https://unavatar.io/elon-musk", + photo_url="https://unavatar.io/elon-musk", + lead_source="Cold Call", + fax="+12129876543", + description="Internal champion", + current_balance=10.5, + status="open", + active=True, + websites=[ + Website( + id="12345", + url="http://example.com", + type="primary", + ), + ], + addresses=[ + Address( + id="123", + type="primary", + string="25 Spring Street, Blackburn, VIC 3130", + name="HQ US", + line1="Main street", + line2="apt #", + line3="Suite #", + line4="delivery instructions", + street_number="25", + city="San Francisco", + state="CA", + postal_code="94104", + country="US", + latitude="40.759211", + longitude="-73.984638", + county="Santa Clara", + contact_name="Elon Musk", + salutation="Mr", + phone_number="111-111-1111", + fax="122-111-1111", + email="elon@musk.com", + website="https://elonmusk.com", + row_version="1-12345", + ), + ], + social_links=[ + SocialLink( + id="12345", + url="https://www.twitter.com/apideck-io", + type="twitter", + ), + ], + phone_numbers=[ + PhoneNumber( + id="12345", + country_code="1", + area_code="323", + number="111-111-1111", + extension="105", + type="primary", + ), + ], + emails=[ + Email( + id="123", + email="elon@musk.com", + type="primary", + ), + ], + email_domain="gmail.com", + custom_fields=[ + CustomField( + id="2389328923893298", + name="employee_level", + description="Employee Level", + value=None, + ), + ], + tags=Tags(["New"]), + ) # Contact | + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # Update contact + api_response = api_instance.contacts_update(id, contact) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling CrmApi->contacts_update: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Update contact + api_response = api_instance.contacts_update(id, contact, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling CrmApi->contacts_update: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **contact** | [**Contact**](Contact.md)| | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + +### Return type + +[**UpdateContactResponse**](UpdateContactResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Contact updated | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **leads_add** +> CreateLeadResponse leads_add(lead) + +Create lead + +Create lead + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import crm_api +from apideck.model.create_lead_response import CreateLeadResponse +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.lead import Lead +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = crm_api.CrmApi(api_client) + lead = Lead( + name="Elon Musk", + company_name="Spacex", + owner_id="54321", + company_id="2", + contact_id="2", + lead_source="Cold Call", + first_name="Elon", + last_name="Musk", + description="A thinker", + prefix="Sir", + title="CEO", + language="EN", + status="New", + monetary_amount=75000, + currency=Currency("USD"), + fax="+12129876543", + websites=[ + Website( + id="12345", + url="http://example.com", + type="primary", + ), + ], + addresses=[ + Address( + id="123", + type="primary", + string="25 Spring Street, Blackburn, VIC 3130", + name="HQ US", + line1="Main street", + line2="apt #", + line3="Suite #", + line4="delivery instructions", + street_number="25", + city="San Francisco", + state="CA", + postal_code="94104", + country="US", + latitude="40.759211", + longitude="-73.984638", + county="Santa Clara", + contact_name="Elon Musk", + salutation="Mr", + phone_number="111-111-1111", + fax="122-111-1111", + email="elon@musk.com", + website="https://elonmusk.com", + row_version="1-12345", + ), + ], + social_links=[ + SocialLink( + id="12345", + url="https://www.twitter.com/apideck-io", + type="twitter", + ), + ], + phone_numbers=[ + PhoneNumber( + id="12345", + country_code="1", + area_code="323", + number="111-111-1111", + extension="105", + type="primary", + ), + ], + emails=[ + Email( + id="123", + email="elon@musk.com", + type="primary", + ), + ], + custom_fields=[ + CustomField( + id="2389328923893298", + name="employee_level", + description="Employee Level", + value=None, + ), + ], + tags=Tags(["New"]), + ) # Lead | + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + + # example passing only required values which don't have defaults set + try: + # Create lead + api_response = api_instance.leads_add(lead) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling CrmApi->leads_add: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Create lead + api_response = api_instance.leads_add(lead, raw=raw, consumer_id=consumer_id, app_id=app_id, service_id=service_id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling CrmApi->leads_add: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **lead** | [**Lead**](Lead.md)| | + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + +### Return type + +[**CreateLeadResponse**](CreateLeadResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**201** | Lead created | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **leads_all** +> GetLeadsResponse leads_all() + +List leads + +List leads + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import crm_api +from apideck.model.leads_filter import LeadsFilter +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.get_leads_response import GetLeadsResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.leads_sort import LeadsSort +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = crm_api.CrmApi(api_client) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + cursor = "cursor_example" # str, none_type | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. (optional) + limit = 20 # int | Number of records to return (optional) if omitted the server will use the default value of 20 + filter = LeadsFilter( + name="Elon Musk", + first_name="Elon", + last_name="Musk", + email="elon@tesla.com", + ) # LeadsFilter | Apply filters (optional) + sort = LeadsSort( + by="created_at", + direction=SortDirection("asc"), + ) # LeadsSort | Apply sorting (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + # List leads + api_response = api_instance.leads_all(raw=raw, consumer_id=consumer_id, app_id=app_id, service_id=service_id, cursor=cursor, limit=limit, filter=filter, sort=sort) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling CrmApi->leads_all: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **cursor** | **str, none_type**| Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | [optional] + **limit** | **int**| Number of records to return | [optional] if omitted the server will use the default value of 20 + **filter** | **LeadsFilter**| Apply filters | [optional] + **sort** | **LeadsSort**| Apply sorting | [optional] + +### Return type + +[**GetLeadsResponse**](GetLeadsResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Leads | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **leads_delete** +> DeleteLeadResponse leads_delete(id) + +Delete lead + +Delete lead + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import crm_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.delete_lead_response import DeleteLeadResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = crm_api.CrmApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # Delete lead + api_response = api_instance.leads_delete(id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling CrmApi->leads_delete: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Delete lead + api_response = api_instance.leads_delete(id, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling CrmApi->leads_delete: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + +### Return type + +[**DeleteLeadResponse**](DeleteLeadResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Lead deleted | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **leads_one** +> GetLeadResponse leads_one(id) + +Get lead + +Get lead + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import crm_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.get_lead_response import GetLeadResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = crm_api.CrmApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # Get lead + api_response = api_instance.leads_one(id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling CrmApi->leads_one: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get lead + api_response = api_instance.leads_one(id, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling CrmApi->leads_one: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + +### Return type + +[**GetLeadResponse**](GetLeadResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Lead | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **leads_update** +> UpdateLeadResponse leads_update(id, lead) + +Update lead + +Update lead + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import crm_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.update_lead_response import UpdateLeadResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.lead import Lead +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = crm_api.CrmApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + lead = Lead( + name="Elon Musk", + company_name="Spacex", + owner_id="54321", + company_id="2", + contact_id="2", + lead_source="Cold Call", + first_name="Elon", + last_name="Musk", + description="A thinker", + prefix="Sir", + title="CEO", + language="EN", + status="New", + monetary_amount=75000, + currency=Currency("USD"), + fax="+12129876543", + websites=[ + Website( + id="12345", + url="http://example.com", + type="primary", + ), + ], + addresses=[ + Address( + id="123", + type="primary", + string="25 Spring Street, Blackburn, VIC 3130", + name="HQ US", + line1="Main street", + line2="apt #", + line3="Suite #", + line4="delivery instructions", + street_number="25", + city="San Francisco", + state="CA", + postal_code="94104", + country="US", + latitude="40.759211", + longitude="-73.984638", + county="Santa Clara", + contact_name="Elon Musk", + salutation="Mr", + phone_number="111-111-1111", + fax="122-111-1111", + email="elon@musk.com", + website="https://elonmusk.com", + row_version="1-12345", + ), + ], + social_links=[ + SocialLink( + id="12345", + url="https://www.twitter.com/apideck-io", + type="twitter", + ), + ], + phone_numbers=[ + PhoneNumber( + id="12345", + country_code="1", + area_code="323", + number="111-111-1111", + extension="105", + type="primary", + ), + ], + emails=[ + Email( + id="123", + email="elon@musk.com", + type="primary", + ), + ], + custom_fields=[ + CustomField( + id="2389328923893298", + name="employee_level", + description="Employee Level", + value=None, + ), + ], + tags=Tags(["New"]), + ) # Lead | + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # Update lead + api_response = api_instance.leads_update(id, lead) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling CrmApi->leads_update: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Update lead + api_response = api_instance.leads_update(id, lead, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling CrmApi->leads_update: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **lead** | [**Lead**](Lead.md)| | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + +### Return type + +[**UpdateLeadResponse**](UpdateLeadResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Lead updated | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **notes_add** +> CreateNoteResponse notes_add(note) + +Create note + +Create note + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import crm_api +from apideck.model.note import Note +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.create_note_response import CreateNoteResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = crm_api.CrmApi(api_client) + note = Note( + title="Meeting Notes", + content="Office hours are 9AM-6PM", + owner_id="12345", + contact_id="12345", + company_id="12345", + opportunity_id="12345", + lead_id="12345", + active=True, + ) # Note | + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + + # example passing only required values which don't have defaults set + try: + # Create note + api_response = api_instance.notes_add(note) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling CrmApi->notes_add: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Create note + api_response = api_instance.notes_add(note, raw=raw, consumer_id=consumer_id, app_id=app_id, service_id=service_id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling CrmApi->notes_add: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **note** | [**Note**](Note.md)| | + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + +### Return type + +[**CreateNoteResponse**](CreateNoteResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**201** | Note created | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **notes_all** +> GetNotesResponse notes_all() + +List notes + +List notes + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import crm_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.get_notes_response import GetNotesResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = crm_api.CrmApi(api_client) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + cursor = "cursor_example" # str, none_type | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. (optional) + limit = 20 # int | Number of records to return (optional) if omitted the server will use the default value of 20 + + # example passing only required values which don't have defaults set + # and optional values + try: + # List notes + api_response = api_instance.notes_all(raw=raw, consumer_id=consumer_id, app_id=app_id, service_id=service_id, cursor=cursor, limit=limit) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling CrmApi->notes_all: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **cursor** | **str, none_type**| Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | [optional] + **limit** | **int**| Number of records to return | [optional] if omitted the server will use the default value of 20 + +### Return type + +[**GetNotesResponse**](GetNotesResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Notes | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **notes_delete** +> DeleteNoteResponse notes_delete(id) + +Delete note + +Delete note + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import crm_api +from apideck.model.delete_note_response import DeleteNoteResponse +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = crm_api.CrmApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # Delete note + api_response = api_instance.notes_delete(id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling CrmApi->notes_delete: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Delete note + api_response = api_instance.notes_delete(id, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling CrmApi->notes_delete: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + +### Return type + +[**DeleteNoteResponse**](DeleteNoteResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Note deleted | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **notes_one** +> GetNoteResponse notes_one(id) + +Get note + +Get note + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import crm_api +from apideck.model.get_note_response import GetNoteResponse +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = crm_api.CrmApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # Get note + api_response = api_instance.notes_one(id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling CrmApi->notes_one: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get note + api_response = api_instance.notes_one(id, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling CrmApi->notes_one: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + +### Return type + +[**GetNoteResponse**](GetNoteResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Note | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **notes_update** +> UpdateNoteResponse notes_update(id, note) + +Update note + +Update note + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import crm_api +from apideck.model.note import Note +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.update_note_response import UpdateNoteResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = crm_api.CrmApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + note = Note( + title="Meeting Notes", + content="Office hours are 9AM-6PM", + owner_id="12345", + contact_id="12345", + company_id="12345", + opportunity_id="12345", + lead_id="12345", + active=True, + ) # Note | + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # Update note + api_response = api_instance.notes_update(id, note) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling CrmApi->notes_update: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Update note + api_response = api_instance.notes_update(id, note, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling CrmApi->notes_update: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **note** | [**Note**](Note.md)| | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + +### Return type + +[**UpdateNoteResponse**](UpdateNoteResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Note updated | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **opportunities_add** +> CreateOpportunityResponse opportunities_add(opportunity) + +Create opportunity + +Create opportunity + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import crm_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.create_opportunity_response import CreateOpportunityResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.opportunity import Opportunity +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = crm_api.CrmApi(api_client) + opportunity = Opportunity( + title="New Rocket", + primary_contact_id="12345", + description="Opportunities are created for People and Companies that are interested in buying your products or services. Create Opportunities for People and Companies to move them through one of your Pipelines.", + type="Existing Customer - Upgrade", + monetary_amount=75000, + currency=Currency("USD"), + win_probability=40, + close_date=dateutil_parser('Fri Oct 30 01:00:00 CET 2020').date(), + loss_reason_id="12345", + loss_reason="No budget", + won_reason_id="12345", + won_reason="Best pitch", + pipeline_id="12345", + pipeline_stage_id="12345", + source_id="12345", + lead_id="12345", + lead_source="Website", + contact_id="12345", + company_id="12345", + company_name="Copper", + owner_id="12345", + priority="None", + status="Open", + status_id="12345", + tags=Tags(["New"]), + custom_fields=[ + CustomField( + id="2389328923893298", + name="employee_level", + description="Employee Level", + value=None, + ), + ], + stage_last_changed_at=dateutil_parser('2020-09-30T07:43:32Z'), + ) # Opportunity | + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + + # example passing only required values which don't have defaults set + try: + # Create opportunity + api_response = api_instance.opportunities_add(opportunity) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling CrmApi->opportunities_add: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Create opportunity + api_response = api_instance.opportunities_add(opportunity, raw=raw, consumer_id=consumer_id, app_id=app_id, service_id=service_id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling CrmApi->opportunities_add: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **opportunity** | [**Opportunity**](Opportunity.md)| | + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + +### Return type + +[**CreateOpportunityResponse**](CreateOpportunityResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**201** | Opportunity created | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **opportunities_all** +> GetOpportunitiesResponse opportunities_all() + +List opportunities + +List opportunities + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import crm_api +from apideck.model.opportunities_sort import OpportunitiesSort +from apideck.model.opportunities_filter import OpportunitiesFilter +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.get_opportunities_response import GetOpportunitiesResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = crm_api.CrmApi(api_client) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + cursor = "cursor_example" # str, none_type | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. (optional) + limit = 20 # int | Number of records to return (optional) if omitted the server will use the default value of 20 + filter = OpportunitiesFilter( + title="Tesla deal", + status="Completed", + monetary_amount=75000, + win_probability=50, + company_id="1234", + ) # OpportunitiesFilter | Apply filters (optional) + sort = OpportunitiesSort( + by="created_at", + direction=SortDirection("asc"), + ) # OpportunitiesSort | Apply sorting (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + # List opportunities + api_response = api_instance.opportunities_all(raw=raw, consumer_id=consumer_id, app_id=app_id, service_id=service_id, cursor=cursor, limit=limit, filter=filter, sort=sort) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling CrmApi->opportunities_all: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **cursor** | **str, none_type**| Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | [optional] + **limit** | **int**| Number of records to return | [optional] if omitted the server will use the default value of 20 + **filter** | **OpportunitiesFilter**| Apply filters | [optional] + **sort** | **OpportunitiesSort**| Apply sorting | [optional] + +### Return type + +[**GetOpportunitiesResponse**](GetOpportunitiesResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Opportunities | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **opportunities_delete** +> DeleteOpportunityResponse opportunities_delete(id) + +Delete opportunity + +Delete opportunity + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import crm_api +from apideck.model.delete_opportunity_response import DeleteOpportunityResponse +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = crm_api.CrmApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # Delete opportunity + api_response = api_instance.opportunities_delete(id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling CrmApi->opportunities_delete: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Delete opportunity + api_response = api_instance.opportunities_delete(id, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling CrmApi->opportunities_delete: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + +### Return type + +[**DeleteOpportunityResponse**](DeleteOpportunityResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Opportunity deleted | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **opportunities_one** +> GetOpportunityResponse opportunities_one(id) + +Get opportunity + +Get opportunity + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import crm_api +from apideck.model.get_opportunity_response import GetOpportunityResponse +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = crm_api.CrmApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # Get opportunity + api_response = api_instance.opportunities_one(id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling CrmApi->opportunities_one: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get opportunity + api_response = api_instance.opportunities_one(id, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling CrmApi->opportunities_one: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + +### Return type + +[**GetOpportunityResponse**](GetOpportunityResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Opportunity | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **opportunities_update** +> UpdateOpportunityResponse opportunities_update(id, opportunity) + +Update opportunity + +Update opportunity + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import crm_api +from apideck.model.update_opportunity_response import UpdateOpportunityResponse +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.opportunity import Opportunity +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = crm_api.CrmApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + opportunity = Opportunity( + title="New Rocket", + primary_contact_id="12345", + description="Opportunities are created for People and Companies that are interested in buying your products or services. Create Opportunities for People and Companies to move them through one of your Pipelines.", + type="Existing Customer - Upgrade", + monetary_amount=75000, + currency=Currency("USD"), + win_probability=40, + close_date=dateutil_parser('Fri Oct 30 01:00:00 CET 2020').date(), + loss_reason_id="12345", + loss_reason="No budget", + won_reason_id="12345", + won_reason="Best pitch", + pipeline_id="12345", + pipeline_stage_id="12345", + source_id="12345", + lead_id="12345", + lead_source="Website", + contact_id="12345", + company_id="12345", + company_name="Copper", + owner_id="12345", + priority="None", + status="Open", + status_id="12345", + tags=Tags(["New"]), + custom_fields=[ + CustomField( + id="2389328923893298", + name="employee_level", + description="Employee Level", + value=None, + ), + ], + stage_last_changed_at=dateutil_parser('2020-09-30T07:43:32Z'), + ) # Opportunity | + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # Update opportunity + api_response = api_instance.opportunities_update(id, opportunity) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling CrmApi->opportunities_update: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Update opportunity + api_response = api_instance.opportunities_update(id, opportunity, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling CrmApi->opportunities_update: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **opportunity** | [**Opportunity**](Opportunity.md)| | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + +### Return type + +[**UpdateOpportunityResponse**](UpdateOpportunityResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Opportunity updated | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **pipelines_add** +> CreatePipelineResponse pipelines_add(pipeline) + +Create pipeline + +Create pipeline + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import crm_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.create_pipeline_response import CreatePipelineResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.pipeline import Pipeline +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = crm_api.CrmApi(api_client) + pipeline = Pipeline( + id="default", + name="Sales Pipeline", + currency=Currency("USD"), + archived=False, + active=False, + display_order=1, + win_probability_enabled=True, + stages=[ + PipelineStages( + name="Contract Sent", + value="CONTRACT_SENT", + win_probability=50, + display_order=1, + ), + ], + ) # Pipeline | + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + + # example passing only required values which don't have defaults set + try: + # Create pipeline + api_response = api_instance.pipelines_add(pipeline) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling CrmApi->pipelines_add: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Create pipeline + api_response = api_instance.pipelines_add(pipeline, raw=raw, consumer_id=consumer_id, app_id=app_id, service_id=service_id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling CrmApi->pipelines_add: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pipeline** | [**Pipeline**](Pipeline.md)| | + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + +### Return type + +[**CreatePipelineResponse**](CreatePipelineResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**201** | Pipeline created | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **pipelines_all** +> GetPipelinesResponse pipelines_all() + +List pipelines + +List pipelines + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import crm_api +from apideck.model.get_pipelines_response import GetPipelinesResponse +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = crm_api.CrmApi(api_client) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + cursor = "cursor_example" # str, none_type | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. (optional) + limit = 20 # int | Number of records to return (optional) if omitted the server will use the default value of 20 + + # example passing only required values which don't have defaults set + # and optional values + try: + # List pipelines + api_response = api_instance.pipelines_all(raw=raw, consumer_id=consumer_id, app_id=app_id, service_id=service_id, cursor=cursor, limit=limit) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling CrmApi->pipelines_all: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **cursor** | **str, none_type**| Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | [optional] + **limit** | **int**| Number of records to return | [optional] if omitted the server will use the default value of 20 + +### Return type + +[**GetPipelinesResponse**](GetPipelinesResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Pipelines | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **pipelines_delete** +> DeletePipelineResponse pipelines_delete(id) + +Delete pipeline + +Delete pipeline + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import crm_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.delete_pipeline_response import DeletePipelineResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = crm_api.CrmApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # Delete pipeline + api_response = api_instance.pipelines_delete(id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling CrmApi->pipelines_delete: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Delete pipeline + api_response = api_instance.pipelines_delete(id, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling CrmApi->pipelines_delete: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + +### Return type + +[**DeletePipelineResponse**](DeletePipelineResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Pipeline deleted | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **pipelines_one** +> GetPipelineResponse pipelines_one(id) + +Get pipeline + +Get pipeline + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import crm_api +from apideck.model.get_pipeline_response import GetPipelineResponse +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = crm_api.CrmApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # Get pipeline + api_response = api_instance.pipelines_one(id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling CrmApi->pipelines_one: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get pipeline + api_response = api_instance.pipelines_one(id, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling CrmApi->pipelines_one: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + +### Return type + +[**GetPipelineResponse**](GetPipelineResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Pipeline | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **pipelines_update** +> UpdatePipelineResponse pipelines_update(id, pipeline) + +Update pipeline + +Update pipeline + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import crm_api +from apideck.model.update_pipeline_response import UpdatePipelineResponse +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.pipeline import Pipeline +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = crm_api.CrmApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + pipeline = Pipeline( + id="default", + name="Sales Pipeline", + currency=Currency("USD"), + archived=False, + active=False, + display_order=1, + win_probability_enabled=True, + stages=[ + PipelineStages( + name="Contract Sent", + value="CONTRACT_SENT", + win_probability=50, + display_order=1, + ), + ], + ) # Pipeline | + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # Update pipeline + api_response = api_instance.pipelines_update(id, pipeline) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling CrmApi->pipelines_update: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Update pipeline + api_response = api_instance.pipelines_update(id, pipeline, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling CrmApi->pipelines_update: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **pipeline** | [**Pipeline**](Pipeline.md)| | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + +### Return type + +[**UpdatePipelineResponse**](UpdatePipelineResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Pipeline updated | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **users_add** +> CreateUserResponse users_add(user) + +Create user + +Create user + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import crm_api +from apideck.model.create_user_response import CreateUserResponse +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.user import User +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = crm_api.CrmApi(api_client) + user = User( + parent_id="54321", + username="masterofcoin", + first_name="Elon", + last_name="Musk", + title="CEO", + division="Europe", + department="R&D", + company_name="SpaceX", + employee_number="123456-AB", + description="A description", + image="https://logo.clearbit.com/spacex.com?s=128", + language="EN", + status="active", + password="supersecretpassword", + addresses=[ + Address( + id="123", + type="primary", + string="25 Spring Street, Blackburn, VIC 3130", + name="HQ US", + line1="Main street", + line2="apt #", + line3="Suite #", + line4="delivery instructions", + street_number="25", + city="San Francisco", + state="CA", + postal_code="94104", + country="US", + latitude="40.759211", + longitude="-73.984638", + county="Santa Clara", + contact_name="Elon Musk", + salutation="Mr", + phone_number="111-111-1111", + fax="122-111-1111", + email="elon@musk.com", + website="https://elonmusk.com", + row_version="1-12345", + ), + ], + phone_numbers=[ + PhoneNumber( + id="12345", + country_code="1", + area_code="323", + number="111-111-1111", + extension="105", + type="primary", + ), + ], + emails=[ + Email( + id="123", + email="elon@musk.com", + type="primary", + ), + ], + ) # User | + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + + # example passing only required values which don't have defaults set + try: + # Create user + api_response = api_instance.users_add(user) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling CrmApi->users_add: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Create user + api_response = api_instance.users_add(user, raw=raw, consumer_id=consumer_id, app_id=app_id, service_id=service_id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling CrmApi->users_add: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **user** | [**User**](User.md)| | + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + +### Return type + +[**CreateUserResponse**](CreateUserResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**201** | User created | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **users_all** +> GetUsersResponse users_all() + +List users + +List users + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import crm_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.get_users_response import GetUsersResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = crm_api.CrmApi(api_client) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + cursor = "cursor_example" # str, none_type | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. (optional) + limit = 20 # int | Number of records to return (optional) if omitted the server will use the default value of 20 + + # example passing only required values which don't have defaults set + # and optional values + try: + # List users + api_response = api_instance.users_all(raw=raw, consumer_id=consumer_id, app_id=app_id, service_id=service_id, cursor=cursor, limit=limit) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling CrmApi->users_all: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **cursor** | **str, none_type**| Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | [optional] + **limit** | **int**| Number of records to return | [optional] if omitted the server will use the default value of 20 + +### Return type + +[**GetUsersResponse**](GetUsersResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Users | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **users_delete** +> DeleteUserResponse users_delete(id) + +Delete user + +Delete user + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import crm_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.delete_user_response import DeleteUserResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = crm_api.CrmApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # Delete user + api_response = api_instance.users_delete(id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling CrmApi->users_delete: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Delete user + api_response = api_instance.users_delete(id, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling CrmApi->users_delete: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + +### Return type + +[**DeleteUserResponse**](DeleteUserResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | User deleted | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **users_one** +> GetUserResponse users_one(id) + +Get user + +Get user + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import crm_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.get_user_response import GetUserResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = crm_api.CrmApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # Get user + api_response = api_instance.users_one(id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling CrmApi->users_one: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get user + api_response = api_instance.users_one(id, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling CrmApi->users_one: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + +### Return type + +[**GetUserResponse**](GetUserResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | User | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **users_update** +> UpdateUserResponse users_update(id, user) + +Update user + +Update user + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import crm_api +from apideck.model.update_user_response import UpdateUserResponse +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.user import User +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = crm_api.CrmApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + user = User( + parent_id="54321", + username="masterofcoin", + first_name="Elon", + last_name="Musk", + title="CEO", + division="Europe", + department="R&D", + company_name="SpaceX", + employee_number="123456-AB", + description="A description", + image="https://logo.clearbit.com/spacex.com?s=128", + language="EN", + status="active", + password="supersecretpassword", + addresses=[ + Address( + id="123", + type="primary", + string="25 Spring Street, Blackburn, VIC 3130", + name="HQ US", + line1="Main street", + line2="apt #", + line3="Suite #", + line4="delivery instructions", + street_number="25", + city="San Francisco", + state="CA", + postal_code="94104", + country="US", + latitude="40.759211", + longitude="-73.984638", + county="Santa Clara", + contact_name="Elon Musk", + salutation="Mr", + phone_number="111-111-1111", + fax="122-111-1111", + email="elon@musk.com", + website="https://elonmusk.com", + row_version="1-12345", + ), + ], + phone_numbers=[ + PhoneNumber( + id="12345", + country_code="1", + area_code="323", + number="111-111-1111", + extension="105", + type="primary", + ), + ], + emails=[ + Email( + id="123", + email="elon@musk.com", + type="primary", + ), + ], + ) # User | + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # Update user + api_response = api_instance.users_update(id, user) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling CrmApi->users_update: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Update user + api_response = api_instance.users_update(id, user, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling CrmApi->users_update: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **user** | [**User**](User.md)| | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + +### Return type + +[**UpdateUserResponse**](UpdateUserResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | User updated | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + diff --git a/docs/apis/CustomerSupportApi.md b/docs/apis/CustomerSupportApi.md new file mode 100644 index 0000000000..756a036bb2 --- /dev/null +++ b/docs/apis/CustomerSupportApi.md @@ -0,0 +1,674 @@ +# apideck.CustomerSupportApi + +All URIs are relative to *https://unify.apideck.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**customers_add**](CustomerSupportApi.md#customers_add) | **POST** /customer-support/customers | Create Customer Support Customer +[**customers_all**](CustomerSupportApi.md#customers_all) | **GET** /customer-support/customers | List Customer Support Customers +[**customers_delete**](CustomerSupportApi.md#customers_delete) | **DELETE** /customer-support/customers/{id} | Delete Customer Support Customer +[**customers_one**](CustomerSupportApi.md#customers_one) | **GET** /customer-support/customers/{id} | Get Customer Support Customer +[**customers_update**](CustomerSupportApi.md#customers_update) | **PATCH** /customer-support/customers/{id} | Update Customer Support Customer + + +# **customers_add** +> CreateCustomerSupportCustomerResponse customers_add(customer_support_customer) + +Create Customer Support Customer + +Create Customer Support Customer + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import customer_support_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.create_customer_support_customer_response import CreateCustomerSupportCustomerResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.customer_support_customer import CustomerSupportCustomer +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = customer_support_api.CustomerSupportApi(api_client) + customer_support_customer = CustomerSupportCustomer( + company_name="SpaceX", + first_name="Elon", + last_name="Musk", + individual=True, + addresses=[ + Address( + id="123", + type="primary", + string="25 Spring Street, Blackburn, VIC 3130", + name="HQ US", + line1="Main street", + line2="apt #", + line3="Suite #", + line4="delivery instructions", + street_number="25", + city="San Francisco", + state="CA", + postal_code="94104", + country="US", + latitude="40.759211", + longitude="-73.984638", + county="Santa Clara", + contact_name="Elon Musk", + salutation="Mr", + phone_number="111-111-1111", + fax="122-111-1111", + email="elon@musk.com", + website="https://elonmusk.com", + row_version="1-12345", + ), + ], + notes="Some notes about this customer", + phone_numbers=[ + PhoneNumber( + id="12345", + country_code="1", + area_code="323", + number="111-111-1111", + extension="105", + type="primary", + ), + ], + emails=[ + Email( + id="123", + email="elon@musk.com", + type="primary", + ), + ], + tax_number="US123945459", + currency=Currency("USD"), + bank_accounts=BankAccount( + iban="CH2989144532982975332", + bic="AUDSCHGGXXX", + bsb_number="062-001", + branch_identifier="001", + bank_code="BNH", + account_number="123465", + account_name="SPACEX LLC", + account_type="credit_card", + currency=Currency("USD"), + ), + status="active", + ) # CustomerSupportCustomer | + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + + # example passing only required values which don't have defaults set + try: + # Create Customer Support Customer + api_response = api_instance.customers_add(customer_support_customer) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling CustomerSupportApi->customers_add: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Create Customer Support Customer + api_response = api_instance.customers_add(customer_support_customer, raw=raw, consumer_id=consumer_id, app_id=app_id, service_id=service_id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling CustomerSupportApi->customers_add: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **customer_support_customer** | [**CustomerSupportCustomer**](CustomerSupportCustomer.md)| | + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + +### Return type + +[**CreateCustomerSupportCustomerResponse**](CreateCustomerSupportCustomerResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**201** | CustomerSupportCustomers | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **customers_all** +> GetCustomerSupportCustomersResponse customers_all() + +List Customer Support Customers + +List Customer Support Customers + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import customer_support_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.get_customer_support_customers_response import GetCustomerSupportCustomersResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = customer_support_api.CustomerSupportApi(api_client) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + cursor = "cursor_example" # str, none_type | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. (optional) + limit = 20 # int | Number of records to return (optional) if omitted the server will use the default value of 20 + + # example passing only required values which don't have defaults set + # and optional values + try: + # List Customer Support Customers + api_response = api_instance.customers_all(raw=raw, consumer_id=consumer_id, app_id=app_id, service_id=service_id, cursor=cursor, limit=limit) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling CustomerSupportApi->customers_all: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **cursor** | **str, none_type**| Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | [optional] + **limit** | **int**| Number of records to return | [optional] if omitted the server will use the default value of 20 + +### Return type + +[**GetCustomerSupportCustomersResponse**](GetCustomerSupportCustomersResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | CustomerSupportCustomers | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **customers_delete** +> DeleteCustomerSupportCustomerResponse customers_delete(id) + +Delete Customer Support Customer + +Delete Customer Support Customer + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import customer_support_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.delete_customer_support_customer_response import DeleteCustomerSupportCustomerResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = customer_support_api.CustomerSupportApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # Delete Customer Support Customer + api_response = api_instance.customers_delete(id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling CustomerSupportApi->customers_delete: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Delete Customer Support Customer + api_response = api_instance.customers_delete(id, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling CustomerSupportApi->customers_delete: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + +### Return type + +[**DeleteCustomerSupportCustomerResponse**](DeleteCustomerSupportCustomerResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | CustomerSupportCustomers | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **customers_one** +> GetCustomerSupportCustomerResponse customers_one(id) + +Get Customer Support Customer + +Get Customer Support Customer + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import customer_support_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.get_customer_support_customer_response import GetCustomerSupportCustomerResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = customer_support_api.CustomerSupportApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # Get Customer Support Customer + api_response = api_instance.customers_one(id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling CustomerSupportApi->customers_one: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get Customer Support Customer + api_response = api_instance.customers_one(id, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling CustomerSupportApi->customers_one: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + +### Return type + +[**GetCustomerSupportCustomerResponse**](GetCustomerSupportCustomerResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | CustomerSupportCustomers | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **customers_update** +> UpdateCustomerSupportCustomerResponse customers_update(id, customer_support_customer) + +Update Customer Support Customer + +Update Customer Support Customer + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import customer_support_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.update_customer_support_customer_response import UpdateCustomerSupportCustomerResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.customer_support_customer import CustomerSupportCustomer +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = customer_support_api.CustomerSupportApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + customer_support_customer = CustomerSupportCustomer( + company_name="SpaceX", + first_name="Elon", + last_name="Musk", + individual=True, + addresses=[ + Address( + id="123", + type="primary", + string="25 Spring Street, Blackburn, VIC 3130", + name="HQ US", + line1="Main street", + line2="apt #", + line3="Suite #", + line4="delivery instructions", + street_number="25", + city="San Francisco", + state="CA", + postal_code="94104", + country="US", + latitude="40.759211", + longitude="-73.984638", + county="Santa Clara", + contact_name="Elon Musk", + salutation="Mr", + phone_number="111-111-1111", + fax="122-111-1111", + email="elon@musk.com", + website="https://elonmusk.com", + row_version="1-12345", + ), + ], + notes="Some notes about this customer", + phone_numbers=[ + PhoneNumber( + id="12345", + country_code="1", + area_code="323", + number="111-111-1111", + extension="105", + type="primary", + ), + ], + emails=[ + Email( + id="123", + email="elon@musk.com", + type="primary", + ), + ], + tax_number="US123945459", + currency=Currency("USD"), + bank_accounts=BankAccount( + iban="CH2989144532982975332", + bic="AUDSCHGGXXX", + bsb_number="062-001", + branch_identifier="001", + bank_code="BNH", + account_number="123465", + account_name="SPACEX LLC", + account_type="credit_card", + currency=Currency("USD"), + ), + status="active", + ) # CustomerSupportCustomer | + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # Update Customer Support Customer + api_response = api_instance.customers_update(id, customer_support_customer) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling CustomerSupportApi->customers_update: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Update Customer Support Customer + api_response = api_instance.customers_update(id, customer_support_customer, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling CustomerSupportApi->customers_update: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **customer_support_customer** | [**CustomerSupportCustomer**](CustomerSupportCustomer.md)| | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + +### Return type + +[**UpdateCustomerSupportCustomerResponse**](UpdateCustomerSupportCustomerResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | CustomerSupportCustomers | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + diff --git a/docs/apis/FileStorageApi.md b/docs/apis/FileStorageApi.md new file mode 100644 index 0000000000..dabfcf4e8c --- /dev/null +++ b/docs/apis/FileStorageApi.md @@ -0,0 +1,3203 @@ +# apideck.FileStorageApi + +All URIs are relative to *https://unify.apideck.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**drive_groups_add**](FileStorageApi.md#drive_groups_add) | **POST** /file-storage/drive-groups | Create DriveGroup +[**drive_groups_all**](FileStorageApi.md#drive_groups_all) | **GET** /file-storage/drive-groups | List DriveGroups +[**drive_groups_delete**](FileStorageApi.md#drive_groups_delete) | **DELETE** /file-storage/drive-groups/{id} | Delete DriveGroup +[**drive_groups_one**](FileStorageApi.md#drive_groups_one) | **GET** /file-storage/drive-groups/{id} | Get DriveGroup +[**drive_groups_update**](FileStorageApi.md#drive_groups_update) | **PATCH** /file-storage/drive-groups/{id} | Update DriveGroup +[**drives_add**](FileStorageApi.md#drives_add) | **POST** /file-storage/drives | Create Drive +[**drives_all**](FileStorageApi.md#drives_all) | **GET** /file-storage/drives | List Drives +[**drives_delete**](FileStorageApi.md#drives_delete) | **DELETE** /file-storage/drives/{id} | Delete Drive +[**drives_one**](FileStorageApi.md#drives_one) | **GET** /file-storage/drives/{id} | Get Drive +[**drives_update**](FileStorageApi.md#drives_update) | **PATCH** /file-storage/drives/{id} | Update Drive +[**files_all**](FileStorageApi.md#files_all) | **GET** /file-storage/files | List Files +[**files_delete**](FileStorageApi.md#files_delete) | **DELETE** /file-storage/files/{id} | Delete File +[**files_download**](FileStorageApi.md#files_download) | **GET** /file-storage/files/{id}/download | Download File +[**files_one**](FileStorageApi.md#files_one) | **GET** /file-storage/files/{id} | Get File +[**files_search**](FileStorageApi.md#files_search) | **POST** /file-storage/files/search | Search Files +[**folders_add**](FileStorageApi.md#folders_add) | **POST** /file-storage/folders | Create Folder +[**folders_copy**](FileStorageApi.md#folders_copy) | **POST** /file-storage/folders/{id}/copy | Copy Folder +[**folders_delete**](FileStorageApi.md#folders_delete) | **DELETE** /file-storage/folders/{id} | Delete Folder +[**folders_one**](FileStorageApi.md#folders_one) | **GET** /file-storage/folders/{id} | Get Folder +[**folders_update**](FileStorageApi.md#folders_update) | **PATCH** /file-storage/folders/{id} | Rename or move Folder +[**shared_links_add**](FileStorageApi.md#shared_links_add) | **POST** /file-storage/shared-links | Create Shared Link +[**shared_links_all**](FileStorageApi.md#shared_links_all) | **GET** /file-storage/shared-links | List SharedLinks +[**shared_links_delete**](FileStorageApi.md#shared_links_delete) | **DELETE** /file-storage/shared-links/{id} | Delete Shared Link +[**shared_links_one**](FileStorageApi.md#shared_links_one) | **GET** /file-storage/shared-links/{id} | Get Shared Link +[**shared_links_update**](FileStorageApi.md#shared_links_update) | **PATCH** /file-storage/shared-links/{id} | Update Shared Link +[**upload_sessions_add**](FileStorageApi.md#upload_sessions_add) | **POST** /file-storage/upload-sessions | Start Upload Session +[**upload_sessions_delete**](FileStorageApi.md#upload_sessions_delete) | **DELETE** /file-storage/upload-sessions/{id} | Abort Upload Session +[**upload_sessions_finish**](FileStorageApi.md#upload_sessions_finish) | **POST** /file-storage/upload-sessions/{id}/finish | Finish Upload Session +[**upload_sessions_one**](FileStorageApi.md#upload_sessions_one) | **GET** /file-storage/upload-sessions/{id} | Get Upload Session + + +# **drive_groups_add** +> CreateDriveGroupResponse drive_groups_add(drive_group) + +Create DriveGroup + +Create DriveGroup + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import file_storage_api +from apideck.model.drive_group import DriveGroup +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.create_drive_group_response import CreateDriveGroupResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = file_storage_api.FileStorageApi(api_client) + drive_group = DriveGroup( + name="accounting", + display_name="accounting", + description="A description", + ) # DriveGroup | + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + + # example passing only required values which don't have defaults set + try: + # Create DriveGroup + api_response = api_instance.drive_groups_add(drive_group) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling FileStorageApi->drive_groups_add: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Create DriveGroup + api_response = api_instance.drive_groups_add(drive_group, raw=raw, consumer_id=consumer_id, app_id=app_id, service_id=service_id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling FileStorageApi->drive_groups_add: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **drive_group** | [**DriveGroup**](DriveGroup.md)| | + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + +### Return type + +[**CreateDriveGroupResponse**](CreateDriveGroupResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**201** | DriveGroups | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **drive_groups_all** +> GetDriveGroupsResponse drive_groups_all() + +List DriveGroups + +List DriveGroups + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import file_storage_api +from apideck.model.get_drive_groups_response import GetDriveGroupsResponse +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.drive_groups_filter import DriveGroupsFilter +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = file_storage_api.FileStorageApi(api_client) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + cursor = "cursor_example" # str, none_type | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. (optional) + limit = 20 # int | Number of records to return (optional) if omitted the server will use the default value of 20 + filter = DriveGroupsFilter( + parent_group_id="1234", + ) # DriveGroupsFilter | Apply filters (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + # List DriveGroups + api_response = api_instance.drive_groups_all(raw=raw, consumer_id=consumer_id, app_id=app_id, service_id=service_id, cursor=cursor, limit=limit, filter=filter) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling FileStorageApi->drive_groups_all: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **cursor** | **str, none_type**| Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | [optional] + **limit** | **int**| Number of records to return | [optional] if omitted the server will use the default value of 20 + **filter** | **DriveGroupsFilter**| Apply filters | [optional] + +### Return type + +[**GetDriveGroupsResponse**](GetDriveGroupsResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | DriveGroups | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **drive_groups_delete** +> DeleteDriveGroupResponse drive_groups_delete(id) + +Delete DriveGroup + +Delete DriveGroup + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import file_storage_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.delete_drive_group_response import DeleteDriveGroupResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = file_storage_api.FileStorageApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # Delete DriveGroup + api_response = api_instance.drive_groups_delete(id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling FileStorageApi->drive_groups_delete: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Delete DriveGroup + api_response = api_instance.drive_groups_delete(id, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling FileStorageApi->drive_groups_delete: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + +### Return type + +[**DeleteDriveGroupResponse**](DeleteDriveGroupResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | DriveGroups | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **drive_groups_one** +> GetDriveGroupResponse drive_groups_one(id) + +Get DriveGroup + +Get DriveGroup + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import file_storage_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.get_drive_group_response import GetDriveGroupResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = file_storage_api.FileStorageApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # Get DriveGroup + api_response = api_instance.drive_groups_one(id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling FileStorageApi->drive_groups_one: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get DriveGroup + api_response = api_instance.drive_groups_one(id, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling FileStorageApi->drive_groups_one: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + +### Return type + +[**GetDriveGroupResponse**](GetDriveGroupResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | DriveGroups | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **drive_groups_update** +> UpdateDriveGroupResponse drive_groups_update(id, drive_group) + +Update DriveGroup + +Update DriveGroup + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import file_storage_api +from apideck.model.drive_group import DriveGroup +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.update_drive_group_response import UpdateDriveGroupResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = file_storage_api.FileStorageApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + drive_group = DriveGroup( + name="accounting", + display_name="accounting", + description="A description", + ) # DriveGroup | + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # Update DriveGroup + api_response = api_instance.drive_groups_update(id, drive_group) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling FileStorageApi->drive_groups_update: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Update DriveGroup + api_response = api_instance.drive_groups_update(id, drive_group, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling FileStorageApi->drive_groups_update: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **drive_group** | [**DriveGroup**](DriveGroup.md)| | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + +### Return type + +[**UpdateDriveGroupResponse**](UpdateDriveGroupResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | DriveGroups | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **drives_add** +> CreateDriveResponse drives_add(drive) + +Create Drive + +Create Drive + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import file_storage_api +from apideck.model.drive import Drive +from apideck.model.create_drive_response import CreateDriveResponse +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = file_storage_api.FileStorageApi(api_client) + drive = Drive( + name="Project Resources", + description="A description", + ) # Drive | + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + + # example passing only required values which don't have defaults set + try: + # Create Drive + api_response = api_instance.drives_add(drive) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling FileStorageApi->drives_add: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Create Drive + api_response = api_instance.drives_add(drive, raw=raw, consumer_id=consumer_id, app_id=app_id, service_id=service_id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling FileStorageApi->drives_add: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **drive** | [**Drive**](Drive.md)| | + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + +### Return type + +[**CreateDriveResponse**](CreateDriveResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**201** | Drives | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **drives_all** +> GetDrivesResponse drives_all() + +List Drives + +List Drives + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import file_storage_api +from apideck.model.get_drives_response import GetDrivesResponse +from apideck.model.drives_filter import DrivesFilter +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = file_storage_api.FileStorageApi(api_client) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + cursor = "cursor_example" # str, none_type | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. (optional) + limit = 20 # int | Number of records to return (optional) if omitted the server will use the default value of 20 + filter = DrivesFilter( + group_id="1234", + ) # DrivesFilter | Apply filters (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + # List Drives + api_response = api_instance.drives_all(raw=raw, consumer_id=consumer_id, app_id=app_id, service_id=service_id, cursor=cursor, limit=limit, filter=filter) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling FileStorageApi->drives_all: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **cursor** | **str, none_type**| Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | [optional] + **limit** | **int**| Number of records to return | [optional] if omitted the server will use the default value of 20 + **filter** | **DrivesFilter**| Apply filters | [optional] + +### Return type + +[**GetDrivesResponse**](GetDrivesResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Drives | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **drives_delete** +> DeleteDriveResponse drives_delete(id) + +Delete Drive + +Delete Drive + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import file_storage_api +from apideck.model.delete_drive_response import DeleteDriveResponse +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = file_storage_api.FileStorageApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # Delete Drive + api_response = api_instance.drives_delete(id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling FileStorageApi->drives_delete: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Delete Drive + api_response = api_instance.drives_delete(id, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling FileStorageApi->drives_delete: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + +### Return type + +[**DeleteDriveResponse**](DeleteDriveResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Drives | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **drives_one** +> GetDriveResponse drives_one(id) + +Get Drive + +Get Drive + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import file_storage_api +from apideck.model.get_drive_response import GetDriveResponse +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = file_storage_api.FileStorageApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # Get Drive + api_response = api_instance.drives_one(id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling FileStorageApi->drives_one: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get Drive + api_response = api_instance.drives_one(id, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling FileStorageApi->drives_one: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + +### Return type + +[**GetDriveResponse**](GetDriveResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Drives | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **drives_update** +> UpdateDriveResponse drives_update(id, drive) + +Update Drive + +Update Drive + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import file_storage_api +from apideck.model.drive import Drive +from apideck.model.update_drive_response import UpdateDriveResponse +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = file_storage_api.FileStorageApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + drive = Drive( + name="Project Resources", + description="A description", + ) # Drive | + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # Update Drive + api_response = api_instance.drives_update(id, drive) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling FileStorageApi->drives_update: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Update Drive + api_response = api_instance.drives_update(id, drive, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling FileStorageApi->drives_update: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **drive** | [**Drive**](Drive.md)| | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + +### Return type + +[**UpdateDriveResponse**](UpdateDriveResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Drives | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **files_all** +> GetFilesResponse files_all() + +List Files + +List Files + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import file_storage_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.files_sort import FilesSort +from apideck.model.files_filter import FilesFilter +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.get_files_response import GetFilesResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = file_storage_api.FileStorageApi(api_client) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + cursor = "cursor_example" # str, none_type | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. (optional) + limit = 20 # int | Number of records to return (optional) if omitted the server will use the default value of 20 + filter = FilesFilter( + drive_id="1234", + folder_id="root", + shared=True, + ) # FilesFilter | Apply filters (optional) + sort = FilesSort( + by="updated_at", + direction=SortDirection("asc"), + ) # FilesSort | Apply sorting (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + # List Files + api_response = api_instance.files_all(raw=raw, consumer_id=consumer_id, app_id=app_id, service_id=service_id, cursor=cursor, limit=limit, filter=filter, sort=sort) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling FileStorageApi->files_all: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **cursor** | **str, none_type**| Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | [optional] + **limit** | **int**| Number of records to return | [optional] if omitted the server will use the default value of 20 + **filter** | **FilesFilter**| Apply filters | [optional] + **sort** | **FilesSort**| Apply sorting | [optional] + +### Return type + +[**GetFilesResponse**](GetFilesResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Files | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **files_delete** +> DeleteFileResponse files_delete(id) + +Delete File + +Delete File + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import file_storage_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.delete_file_response import DeleteFileResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = file_storage_api.FileStorageApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # Delete File + api_response = api_instance.files_delete(id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling FileStorageApi->files_delete: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Delete File + api_response = api_instance.files_delete(id, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling FileStorageApi->files_delete: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + +### Return type + +[**DeleteFileResponse**](DeleteFileResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Files | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **files_download** +> file_type files_download(id) + +Download File + +Download File + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import file_storage_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = file_storage_api.FileStorageApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + + # example passing only required values which don't have defaults set + try: + # Download File + api_response = api_instance.files_download(id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling FileStorageApi->files_download: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Download File + api_response = api_instance.files_download(id, consumer_id=consumer_id, app_id=app_id, service_id=service_id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling FileStorageApi->files_download: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + +### Return type + +**file_type** + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: */*, application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | File Download | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **files_one** +> GetFileResponse files_one(id) + +Get File + +Get File + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import file_storage_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.get_file_response import GetFileResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = file_storage_api.FileStorageApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # Get File + api_response = api_instance.files_one(id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling FileStorageApi->files_one: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get File + api_response = api_instance.files_one(id, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling FileStorageApi->files_one: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + +### Return type + +[**GetFileResponse**](GetFileResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | File | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **files_search** +> GetFilesResponse files_search(files_search) + +Search Files + +Search Files + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import file_storage_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.get_files_response import GetFilesResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.files_search import FilesSearch +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = file_storage_api.FileStorageApi(api_client) + files_search = FilesSearch( + query="logo jpg", + drive_id="1234", + ) # FilesSearch | + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + + # example passing only required values which don't have defaults set + try: + # Search Files + api_response = api_instance.files_search(files_search) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling FileStorageApi->files_search: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Search Files + api_response = api_instance.files_search(files_search, consumer_id=consumer_id, app_id=app_id, service_id=service_id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling FileStorageApi->files_search: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **files_search** | [**FilesSearch**](FilesSearch.md)| | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + +### Return type + +[**GetFilesResponse**](GetFilesResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Files | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **folders_add** +> CreateFolderResponse folders_add(create_folder_request) + +Create Folder + +Create Folder + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import file_storage_api +from apideck.model.create_folder_request import CreateFolderRequest +from apideck.model.create_folder_response import CreateFolderResponse +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = file_storage_api.FileStorageApi(api_client) + create_folder_request = CreateFolderRequest( + name="Documents", + description="My Personal Documents", + parent_folder_id="1234", + drive_id="1234", + ) # CreateFolderRequest | + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + + # example passing only required values which don't have defaults set + try: + # Create Folder + api_response = api_instance.folders_add(create_folder_request) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling FileStorageApi->folders_add: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Create Folder + api_response = api_instance.folders_add(create_folder_request, raw=raw, consumer_id=consumer_id, app_id=app_id, service_id=service_id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling FileStorageApi->folders_add: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **create_folder_request** | [**CreateFolderRequest**](CreateFolderRequest.md)| | + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + +### Return type + +[**CreateFolderResponse**](CreateFolderResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**201** | Folders | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **folders_copy** +> UpdateFolderResponse folders_copy(id, copy_folder_request) + +Copy Folder + +Copy Folder + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import file_storage_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.update_folder_response import UpdateFolderResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.copy_folder_request import CopyFolderRequest +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = file_storage_api.FileStorageApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + copy_folder_request = CopyFolderRequest( + name="Documents", + parent_folder_id="1234", + ) # CopyFolderRequest | + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # Copy Folder + api_response = api_instance.folders_copy(id, copy_folder_request) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling FileStorageApi->folders_copy: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Copy Folder + api_response = api_instance.folders_copy(id, copy_folder_request, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling FileStorageApi->folders_copy: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **copy_folder_request** | [**CopyFolderRequest**](CopyFolderRequest.md)| | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + +### Return type + +[**UpdateFolderResponse**](UpdateFolderResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Folders | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **folders_delete** +> DeleteFolderResponse folders_delete(id) + +Delete Folder + +Delete Folder + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import file_storage_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.delete_folder_response import DeleteFolderResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = file_storage_api.FileStorageApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # Delete Folder + api_response = api_instance.folders_delete(id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling FileStorageApi->folders_delete: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Delete Folder + api_response = api_instance.folders_delete(id, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling FileStorageApi->folders_delete: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + +### Return type + +[**DeleteFolderResponse**](DeleteFolderResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Folders | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **folders_one** +> GetFolderResponse folders_one(id) + +Get Folder + +Get Folder + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import file_storage_api +from apideck.model.get_folder_response import GetFolderResponse +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = file_storage_api.FileStorageApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # Get Folder + api_response = api_instance.folders_one(id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling FileStorageApi->folders_one: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get Folder + api_response = api_instance.folders_one(id, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling FileStorageApi->folders_one: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + +### Return type + +[**GetFolderResponse**](GetFolderResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Folders | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **folders_update** +> UpdateFolderResponse folders_update(id, update_folder_request) + +Rename or move Folder + +Rename or move Folder + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import file_storage_api +from apideck.model.update_folder_request import UpdateFolderRequest +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.update_folder_response import UpdateFolderResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = file_storage_api.FileStorageApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + update_folder_request = UpdateFolderRequest( + name="Documents", + description="My Personal Documents", + parent_folder_id="1234", + ) # UpdateFolderRequest | + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # Rename or move Folder + api_response = api_instance.folders_update(id, update_folder_request) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling FileStorageApi->folders_update: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Rename or move Folder + api_response = api_instance.folders_update(id, update_folder_request, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling FileStorageApi->folders_update: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **update_folder_request** | [**UpdateFolderRequest**](UpdateFolderRequest.md)| | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + +### Return type + +[**UpdateFolderResponse**](UpdateFolderResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Folders | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **shared_links_add** +> CreateSharedLinkResponse shared_links_add(shared_link) + +Create Shared Link + +Create Shared Link + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import file_storage_api +from apideck.model.create_shared_link_response import CreateSharedLinkResponse +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.shared_link import SharedLink +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = file_storage_api.FileStorageApi(api_client) + shared_link = SharedLink( + download_url="https://www.box.com/shared/static/rh935iit6ewrmw0unyul.jpeg", + target_id="target_id_example", + scope="company", + password="password_example", + ) # SharedLink | + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + + # example passing only required values which don't have defaults set + try: + # Create Shared Link + api_response = api_instance.shared_links_add(shared_link) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling FileStorageApi->shared_links_add: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Create Shared Link + api_response = api_instance.shared_links_add(shared_link, raw=raw, consumer_id=consumer_id, app_id=app_id, service_id=service_id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling FileStorageApi->shared_links_add: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **shared_link** | [**SharedLink**](SharedLink.md)| | + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + +### Return type + +[**CreateSharedLinkResponse**](CreateSharedLinkResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**201** | Shared Links | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **shared_links_all** +> GetSharedLinksResponse shared_links_all() + +List SharedLinks + +List SharedLinks + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import file_storage_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.get_shared_links_response import GetSharedLinksResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = file_storage_api.FileStorageApi(api_client) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + cursor = "cursor_example" # str, none_type | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. (optional) + limit = 20 # int | Number of records to return (optional) if omitted the server will use the default value of 20 + + # example passing only required values which don't have defaults set + # and optional values + try: + # List SharedLinks + api_response = api_instance.shared_links_all(raw=raw, consumer_id=consumer_id, app_id=app_id, service_id=service_id, cursor=cursor, limit=limit) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling FileStorageApi->shared_links_all: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **cursor** | **str, none_type**| Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | [optional] + **limit** | **int**| Number of records to return | [optional] if omitted the server will use the default value of 20 + +### Return type + +[**GetSharedLinksResponse**](GetSharedLinksResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Shared Links | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **shared_links_delete** +> DeleteSharedLinkResponse shared_links_delete(id) + +Delete Shared Link + +Delete Shared Link + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import file_storage_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.delete_shared_link_response import DeleteSharedLinkResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = file_storage_api.FileStorageApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # Delete Shared Link + api_response = api_instance.shared_links_delete(id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling FileStorageApi->shared_links_delete: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Delete Shared Link + api_response = api_instance.shared_links_delete(id, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling FileStorageApi->shared_links_delete: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + +### Return type + +[**DeleteSharedLinkResponse**](DeleteSharedLinkResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Shared Links | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **shared_links_one** +> GetSharedLinkResponse shared_links_one(id) + +Get Shared Link + +Get Shared Link + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import file_storage_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.get_shared_link_response import GetSharedLinkResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = file_storage_api.FileStorageApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # Get Shared Link + api_response = api_instance.shared_links_one(id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling FileStorageApi->shared_links_one: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get Shared Link + api_response = api_instance.shared_links_one(id, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling FileStorageApi->shared_links_one: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + +### Return type + +[**GetSharedLinkResponse**](GetSharedLinkResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Shared Link | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **shared_links_update** +> UpdateSharedLinkResponse shared_links_update(id, shared_link) + +Update Shared Link + +Update Shared Link + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import file_storage_api +from apideck.model.update_shared_link_response import UpdateSharedLinkResponse +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.shared_link import SharedLink +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = file_storage_api.FileStorageApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + shared_link = SharedLink( + download_url="https://www.box.com/shared/static/rh935iit6ewrmw0unyul.jpeg", + target_id="target_id_example", + scope="company", + password="password_example", + ) # SharedLink | + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # Update Shared Link + api_response = api_instance.shared_links_update(id, shared_link) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling FileStorageApi->shared_links_update: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Update Shared Link + api_response = api_instance.shared_links_update(id, shared_link, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling FileStorageApi->shared_links_update: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **shared_link** | [**SharedLink**](SharedLink.md)| | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + +### Return type + +[**UpdateSharedLinkResponse**](UpdateSharedLinkResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Shared Links | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **upload_sessions_add** +> CreateUploadSessionResponse upload_sessions_add(create_upload_session_request) + +Start Upload Session + +Start an Upload Session. Upload sessions are used to upload large files, use the [Upload File](#operation/filesUpload) endpoint to upload smaller files (up to 100MB). + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import file_storage_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.create_upload_session_response import CreateUploadSessionResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.create_upload_session_request import CreateUploadSessionRequest +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = file_storage_api.FileStorageApi(api_client) + create_upload_session_request = CreateUploadSessionRequest( + name="Documents", + parent_folder_id="1234", + drive_id="1234", + size=1810673, + ) # CreateUploadSessionRequest | + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + + # example passing only required values which don't have defaults set + try: + # Start Upload Session + api_response = api_instance.upload_sessions_add(create_upload_session_request) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling FileStorageApi->upload_sessions_add: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Start Upload Session + api_response = api_instance.upload_sessions_add(create_upload_session_request, raw=raw, consumer_id=consumer_id, app_id=app_id, service_id=service_id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling FileStorageApi->upload_sessions_add: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **create_upload_session_request** | [**CreateUploadSessionRequest**](CreateUploadSessionRequest.md)| | + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + +### Return type + +[**CreateUploadSessionResponse**](CreateUploadSessionResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**201** | UploadSessions | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **upload_sessions_delete** +> DeleteUploadSessionResponse upload_sessions_delete(id) + +Abort Upload Session + +Abort Upload Session + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import file_storage_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.delete_upload_session_response import DeleteUploadSessionResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = file_storage_api.FileStorageApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # Abort Upload Session + api_response = api_instance.upload_sessions_delete(id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling FileStorageApi->upload_sessions_delete: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Abort Upload Session + api_response = api_instance.upload_sessions_delete(id, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling FileStorageApi->upload_sessions_delete: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + +### Return type + +[**DeleteUploadSessionResponse**](DeleteUploadSessionResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | UploadSessions | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **upload_sessions_finish** +> GetFileResponse upload_sessions_finish(id) + +Finish Upload Session + +Finish Upload Session. Only call this endpoint after all File parts have been uploaded to [Upload part of File](#operation/uploadSessionsUpload). + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import file_storage_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.get_file_response import GetFileResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = file_storage_api.FileStorageApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + digest = "sha=fpRyg5eVQletdZqEKaFlqwBXJzM=" # str | The RFC3230 message digest of the uploaded part. Only required for the Box connector. More information on the Box API docs [here](https://developer.box.com/reference/put-files-upload-sessions-id/#param-digest) (optional) + body = {} # dict | (optional) + + # example passing only required values which don't have defaults set + try: + # Finish Upload Session + api_response = api_instance.upload_sessions_finish(id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling FileStorageApi->upload_sessions_finish: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Finish Upload Session + api_response = api_instance.upload_sessions_finish(id, raw=raw, consumer_id=consumer_id, app_id=app_id, service_id=service_id, digest=digest, body=body) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling FileStorageApi->upload_sessions_finish: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **digest** | **str**| The RFC3230 message digest of the uploaded part. Only required for the Box connector. More information on the Box API docs [here](https://developer.box.com/reference/put-files-upload-sessions-id/#param-digest) | [optional] + **body** | **dict**| | [optional] + +### Return type + +[**GetFileResponse**](GetFileResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**201** | File | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **upload_sessions_one** +> GetUploadSessionResponse upload_sessions_one(id) + +Get Upload Session + +Get Upload Session. Use the `part_size` to split your file into parts. Upload the parts to the [Upload part of File](#operation/uploadSessionsUpload) endpoint. + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import file_storage_api +from apideck.model.get_upload_session_response import GetUploadSessionResponse +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = file_storage_api.FileStorageApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # Get Upload Session + api_response = api_instance.upload_sessions_one(id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling FileStorageApi->upload_sessions_one: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get Upload Session + api_response = api_instance.upload_sessions_one(id, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling FileStorageApi->upload_sessions_one: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + +### Return type + +[**GetUploadSessionResponse**](GetUploadSessionResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | UploadSessions | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + diff --git a/docs/apis/HrisApi.md b/docs/apis/HrisApi.md new file mode 100644 index 0000000000..44af5b46f8 --- /dev/null +++ b/docs/apis/HrisApi.md @@ -0,0 +1,3454 @@ +# apideck.HrisApi + +All URIs are relative to *https://unify.apideck.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**companies_add**](HrisApi.md#companies_add) | **POST** /hris/companies | Create Company +[**companies_all**](HrisApi.md#companies_all) | **GET** /hris/companies | List Companies +[**companies_delete**](HrisApi.md#companies_delete) | **DELETE** /hris/companies/{id} | Delete Company +[**companies_one**](HrisApi.md#companies_one) | **GET** /hris/companies/{id} | Get Company +[**companies_update**](HrisApi.md#companies_update) | **PATCH** /hris/companies/{id} | Update Company +[**departments_add**](HrisApi.md#departments_add) | **POST** /hris/departments | Create Department +[**departments_all**](HrisApi.md#departments_all) | **GET** /hris/departments | List Departments +[**departments_delete**](HrisApi.md#departments_delete) | **DELETE** /hris/departments/{id} | Delete Department +[**departments_one**](HrisApi.md#departments_one) | **GET** /hris/departments/{id} | Get Department +[**departments_update**](HrisApi.md#departments_update) | **PATCH** /hris/departments/{id} | Update Department +[**employee_payrolls_all**](HrisApi.md#employee_payrolls_all) | **GET** /hris/payrolls/employees/{employee_id} | List Employee Payrolls +[**employee_payrolls_one**](HrisApi.md#employee_payrolls_one) | **GET** /hris/payrolls/employees/{employee_id}/payrolls/{payroll_id} | Get Employee Payroll +[**employee_schedules_all**](HrisApi.md#employee_schedules_all) | **GET** /hris/schedules/employees/{employee_id} | List Employee Schedules +[**employees_add**](HrisApi.md#employees_add) | **POST** /hris/employees | Create Employee +[**employees_all**](HrisApi.md#employees_all) | **GET** /hris/employees | List Employees +[**employees_delete**](HrisApi.md#employees_delete) | **DELETE** /hris/employees/{id} | Delete Employee +[**employees_one**](HrisApi.md#employees_one) | **GET** /hris/employees/{id} | Get Employee +[**employees_update**](HrisApi.md#employees_update) | **PATCH** /hris/employees/{id} | Update Employee +[**jobs_all**](HrisApi.md#jobs_all) | **GET** /hris/jobs/employees/{employee_id} | List Jobs +[**jobs_one**](HrisApi.md#jobs_one) | **GET** /hris/jobs/employees/{employee_id}/jobs/{job_id} | One Job +[**payrolls_all**](HrisApi.md#payrolls_all) | **GET** /hris/payrolls | List Payroll +[**payrolls_one**](HrisApi.md#payrolls_one) | **GET** /hris/payrolls/{payroll_id} | Get Payroll +[**time_off_requests_add**](HrisApi.md#time_off_requests_add) | **POST** /hris/time-off-requests | Create Time Off Request +[**time_off_requests_all**](HrisApi.md#time_off_requests_all) | **GET** /hris/time-off-requests | List Time Off Requests +[**time_off_requests_delete**](HrisApi.md#time_off_requests_delete) | **DELETE** /hris/time-off-requests/{id} | Delete Time Off Request +[**time_off_requests_one**](HrisApi.md#time_off_requests_one) | **GET** /hris/time-off-requests/{id} | Get Time Off Request +[**time_off_requests_update**](HrisApi.md#time_off_requests_update) | **PATCH** /hris/time-off-requests/{id} | Update Time Off Request + + +# **companies_add** +> CreateHrisCompanyResponse companies_add(hris_company) + +Create Company + +Create Company + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import hris_api +from apideck.model.create_hris_company_response import CreateHrisCompanyResponse +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.hris_company import HrisCompany +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = hris_api.HrisApi(api_client) + hris_company = HrisCompany( + legal_name="SpaceX", + display_name="SpaceX", + subdomain="company", + status="active", + company_number="123456-AB", + addresses=[ + Address( + id="123", + type="primary", + string="25 Spring Street, Blackburn, VIC 3130", + name="HQ US", + line1="Main street", + line2="apt #", + line3="Suite #", + line4="delivery instructions", + street_number="25", + city="San Francisco", + state="CA", + postal_code="94104", + country="US", + latitude="40.759211", + longitude="-73.984638", + county="Santa Clara", + contact_name="Elon Musk", + salutation="Mr", + phone_number="111-111-1111", + fax="122-111-1111", + email="elon@musk.com", + website="https://elonmusk.com", + row_version="1-12345", + ), + ], + phone_numbers=[ + PhoneNumber( + id="12345", + country_code="1", + area_code="323", + number="111-111-1111", + extension="105", + type="primary", + ), + ], + emails=[ + Email( + id="123", + email="elon@musk.com", + type="primary", + ), + ], + websites=[ + Website( + id="12345", + url="http://example.com", + type="primary", + ), + ], + debtor_id="12345", + ) # HrisCompany | + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + + # example passing only required values which don't have defaults set + try: + # Create Company + api_response = api_instance.companies_add(hris_company) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling HrisApi->companies_add: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Create Company + api_response = api_instance.companies_add(hris_company, raw=raw, consumer_id=consumer_id, app_id=app_id, service_id=service_id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling HrisApi->companies_add: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **hris_company** | [**HrisCompany**](HrisCompany.md)| | + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + +### Return type + +[**CreateHrisCompanyResponse**](CreateHrisCompanyResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**201** | Companies | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **companies_all** +> GetHrisCompaniesResponse companies_all() + +List Companies + +List Companies + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import hris_api +from apideck.model.get_hris_companies_response import GetHrisCompaniesResponse +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = hris_api.HrisApi(api_client) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + cursor = "cursor_example" # str, none_type | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. (optional) + limit = 20 # int | Number of records to return (optional) if omitted the server will use the default value of 20 + + # example passing only required values which don't have defaults set + # and optional values + try: + # List Companies + api_response = api_instance.companies_all(raw=raw, consumer_id=consumer_id, app_id=app_id, service_id=service_id, cursor=cursor, limit=limit) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling HrisApi->companies_all: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **cursor** | **str, none_type**| Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | [optional] + **limit** | **int**| Number of records to return | [optional] if omitted the server will use the default value of 20 + +### Return type + +[**GetHrisCompaniesResponse**](GetHrisCompaniesResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Companies | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **companies_delete** +> DeleteHrisCompanyResponse companies_delete(id) + +Delete Company + +Delete Company + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import hris_api +from apideck.model.delete_hris_company_response import DeleteHrisCompanyResponse +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = hris_api.HrisApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # Delete Company + api_response = api_instance.companies_delete(id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling HrisApi->companies_delete: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Delete Company + api_response = api_instance.companies_delete(id, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling HrisApi->companies_delete: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + +### Return type + +[**DeleteHrisCompanyResponse**](DeleteHrisCompanyResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Companies | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **companies_one** +> GetHrisCompanyResponse companies_one(id) + +Get Company + +Get Company + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import hris_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.get_hris_company_response import GetHrisCompanyResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = hris_api.HrisApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # Get Company + api_response = api_instance.companies_one(id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling HrisApi->companies_one: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get Company + api_response = api_instance.companies_one(id, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling HrisApi->companies_one: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + +### Return type + +[**GetHrisCompanyResponse**](GetHrisCompanyResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Company | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **companies_update** +> UpdateHrisCompanyResponse companies_update(id, hris_company) + +Update Company + +Update Company + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import hris_api +from apideck.model.update_hris_company_response import UpdateHrisCompanyResponse +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.hris_company import HrisCompany +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = hris_api.HrisApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + hris_company = HrisCompany( + legal_name="SpaceX", + display_name="SpaceX", + subdomain="company", + status="active", + company_number="123456-AB", + addresses=[ + Address( + id="123", + type="primary", + string="25 Spring Street, Blackburn, VIC 3130", + name="HQ US", + line1="Main street", + line2="apt #", + line3="Suite #", + line4="delivery instructions", + street_number="25", + city="San Francisco", + state="CA", + postal_code="94104", + country="US", + latitude="40.759211", + longitude="-73.984638", + county="Santa Clara", + contact_name="Elon Musk", + salutation="Mr", + phone_number="111-111-1111", + fax="122-111-1111", + email="elon@musk.com", + website="https://elonmusk.com", + row_version="1-12345", + ), + ], + phone_numbers=[ + PhoneNumber( + id="12345", + country_code="1", + area_code="323", + number="111-111-1111", + extension="105", + type="primary", + ), + ], + emails=[ + Email( + id="123", + email="elon@musk.com", + type="primary", + ), + ], + websites=[ + Website( + id="12345", + url="http://example.com", + type="primary", + ), + ], + debtor_id="12345", + ) # HrisCompany | + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # Update Company + api_response = api_instance.companies_update(id, hris_company) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling HrisApi->companies_update: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Update Company + api_response = api_instance.companies_update(id, hris_company, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling HrisApi->companies_update: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **hris_company** | [**HrisCompany**](HrisCompany.md)| | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + +### Return type + +[**UpdateHrisCompanyResponse**](UpdateHrisCompanyResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Companies | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **departments_add** +> CreateDepartmentResponse departments_add(department) + +Create Department + +Create Department + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import hris_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.department import Department +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.create_department_response import CreateDepartmentResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = hris_api.HrisApi(api_client) + department = Department( + name="R&D", + code="2", + description="R&D", + ) # Department | + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + + # example passing only required values which don't have defaults set + try: + # Create Department + api_response = api_instance.departments_add(department) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling HrisApi->departments_add: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Create Department + api_response = api_instance.departments_add(department, raw=raw, consumer_id=consumer_id, app_id=app_id, service_id=service_id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling HrisApi->departments_add: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **department** | [**Department**](Department.md)| | + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + +### Return type + +[**CreateDepartmentResponse**](CreateDepartmentResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**201** | Departments | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **departments_all** +> GetDepartmentsResponse departments_all() + +List Departments + +List Departments + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import hris_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.get_departments_response import GetDepartmentsResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = hris_api.HrisApi(api_client) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + cursor = "cursor_example" # str, none_type | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. (optional) + limit = 20 # int | Number of records to return (optional) if omitted the server will use the default value of 20 + + # example passing only required values which don't have defaults set + # and optional values + try: + # List Departments + api_response = api_instance.departments_all(raw=raw, consumer_id=consumer_id, app_id=app_id, service_id=service_id, cursor=cursor, limit=limit) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling HrisApi->departments_all: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **cursor** | **str, none_type**| Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | [optional] + **limit** | **int**| Number of records to return | [optional] if omitted the server will use the default value of 20 + +### Return type + +[**GetDepartmentsResponse**](GetDepartmentsResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Departments | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **departments_delete** +> DeleteDepartmentResponse departments_delete(id) + +Delete Department + +Delete Department + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import hris_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.delete_department_response import DeleteDepartmentResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = hris_api.HrisApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # Delete Department + api_response = api_instance.departments_delete(id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling HrisApi->departments_delete: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Delete Department + api_response = api_instance.departments_delete(id, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling HrisApi->departments_delete: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + +### Return type + +[**DeleteDepartmentResponse**](DeleteDepartmentResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Departments | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **departments_one** +> GetDepartmentResponse departments_one(id) + +Get Department + +Get Department + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import hris_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.get_department_response import GetDepartmentResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = hris_api.HrisApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # Get Department + api_response = api_instance.departments_one(id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling HrisApi->departments_one: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get Department + api_response = api_instance.departments_one(id, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling HrisApi->departments_one: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + +### Return type + +[**GetDepartmentResponse**](GetDepartmentResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Departments | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **departments_update** +> UpdateDepartmentResponse departments_update(id, department) + +Update Department + +Update Department + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import hris_api +from apideck.model.update_department_response import UpdateDepartmentResponse +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.department import Department +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = hris_api.HrisApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + department = Department( + name="R&D", + code="2", + description="R&D", + ) # Department | + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # Update Department + api_response = api_instance.departments_update(id, department) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling HrisApi->departments_update: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Update Department + api_response = api_instance.departments_update(id, department, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling HrisApi->departments_update: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **department** | [**Department**](Department.md)| | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + +### Return type + +[**UpdateDepartmentResponse**](UpdateDepartmentResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Departments | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **employee_payrolls_all** +> GetEmployeePayrollsResponse employee_payrolls_all(employee_id) + +List Employee Payrolls + +List payrolls for employee + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import hris_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.payrolls_filter import PayrollsFilter +from apideck.model.get_employee_payrolls_response import GetEmployeePayrollsResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = hris_api.HrisApi(api_client) + employee_id = "employee_id_example" # str | ID of the employee you are acting upon. + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + filter = PayrollsFilter( + start_date="2022-04-08", + end_date="2022-04-21", + ) # PayrollsFilter | Apply filters (optional) + + # example passing only required values which don't have defaults set + try: + # List Employee Payrolls + api_response = api_instance.employee_payrolls_all(employee_id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling HrisApi->employee_payrolls_all: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # List Employee Payrolls + api_response = api_instance.employee_payrolls_all(employee_id, raw=raw, consumer_id=consumer_id, app_id=app_id, service_id=service_id, filter=filter) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling HrisApi->employee_payrolls_all: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **employee_id** | **str**| ID of the employee you are acting upon. | + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **filter** | **PayrollsFilter**| Apply filters | [optional] + +### Return type + +[**GetEmployeePayrollsResponse**](GetEmployeePayrollsResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | EmployeePayrolls | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **employee_payrolls_one** +> GetEmployeePayrollResponse employee_payrolls_one(payroll_id, employee_id) + +Get Employee Payroll + +Get payroll for employee + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import hris_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.get_employee_payroll_response import GetEmployeePayrollResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = hris_api.HrisApi(api_client) + payroll_id = "payroll_id_example" # str | ID of the payroll you are acting upon. + employee_id = "employee_id_example" # str | ID of the employee you are acting upon. + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + + # example passing only required values which don't have defaults set + try: + # Get Employee Payroll + api_response = api_instance.employee_payrolls_one(payroll_id, employee_id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling HrisApi->employee_payrolls_one: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get Employee Payroll + api_response = api_instance.employee_payrolls_one(payroll_id, employee_id, raw=raw, consumer_id=consumer_id, app_id=app_id, service_id=service_id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling HrisApi->employee_payrolls_one: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **payroll_id** | **str**| ID of the payroll you are acting upon. | + **employee_id** | **str**| ID of the employee you are acting upon. | + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + +### Return type + +[**GetEmployeePayrollResponse**](GetEmployeePayrollResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Payrolls | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **employee_schedules_all** +> GetEmployeeSchedulesResponse employee_schedules_all(employee_id) + +List Employee Schedules + +List schedules for employee, a schedule is a work pattern, not the actual worked hours, for an employee. + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import hris_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.get_employee_schedules_response import GetEmployeeSchedulesResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = hris_api.HrisApi(api_client) + employee_id = "employee_id_example" # str | ID of the employee you are acting upon. + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + + # example passing only required values which don't have defaults set + try: + # List Employee Schedules + api_response = api_instance.employee_schedules_all(employee_id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling HrisApi->employee_schedules_all: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # List Employee Schedules + api_response = api_instance.employee_schedules_all(employee_id, raw=raw, consumer_id=consumer_id, app_id=app_id, service_id=service_id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling HrisApi->employee_schedules_all: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **employee_id** | **str**| ID of the employee you are acting upon. | + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + +### Return type + +[**GetEmployeeSchedulesResponse**](GetEmployeeSchedulesResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | EmployeeSchedules | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **employees_add** +> CreateEmployeeResponse employees_add(employee) + +Create Employee + +Create Employee + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import hris_api +from apideck.model.employee import Employee +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.create_employee_response import CreateEmployeeResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = hris_api.HrisApi(api_client) + employee = Employee( + first_name="Elon", + last_name="Musk", + middle_name="D.", + display_name="Technoking", + preferred_name="Elon Musk", + initials="EM", + salutation="Mr", + title="CEO", + marital_status="married", + partner=EmployeePartner( + first_name="Elon", + last_name="Musk", + middle_name="D.", + gender=Gender("male"), + initials="EM", + birthday=dateutil_parser('Sat Aug 12 02:00:00 CEST 2000').date(), + deceased_on=dateutil_parser('Sat Aug 12 02:00:00 CEST 2000').date(), + ), + division="Europe", + division_id="12345", + department="R&D", + department_id="12345", + team=EmployeeTeam( + id="1234", + name="Full Stack Engineers", + ), + company_id="23456", + company_name="SpaceX", + employment_start_date="2021-10-26", + employment_end_date="2028-10-26", + leaving_reason="active", + employee_number="123456-AB", + employment_status="active", + employment_role=EmployeeEmploymentRole( + type="contractor", + sub_type="full_time", + ), + manager=EmployeeManager( + name="Elon Musk", + first_name="Elon", + last_name="Musk", + email="elon@musk.com", + ), + direct_reports=["a0d636c6-43b3-4bde-8c70-85b707d992f4","a98lfd96-43b3-4bde-8c70-85b707d992e6"], + social_security_number="123456789", + birthday=dateutil_parser('Sat Aug 12 02:00:00 CEST 2000').date(), + deceased_on=dateutil_parser('Sat Aug 12 02:00:00 CEST 2000').date(), + country_of_birth="US", + description="A description", + gender=Gender("male"), + pronouns="she,her", + preferred_language="EN", + languages=[ + "EN", + ], + nationalities=[ + "US", + ], + photo_url="https://unavatar.io/elon-musk", + timezone="Europe/London", + source="lever", + source_id="12345", + record_url="https://app.intercom.io/contacts/12345", + jobs=[ + EmployeeJobs( + title="CEO", + role="Sales", + start_date=dateutil_parser('Wed Aug 12 02:00:00 CEST 2020').date(), + end_date=dateutil_parser('Wed Aug 12 02:00:00 CEST 2020').date(), + compensation_rate=72000, + currency=Currency("USD"), + payment_unit=PaymentUnit("year"), + hired_at=dateutil_parser('Wed Aug 12 02:00:00 CEST 2020').date(), + is_primary=True, + location=Address( + id="123", + type="primary", + string="25 Spring Street, Blackburn, VIC 3130", + name="HQ US", + line1="Main street", + line2="apt #", + line3="Suite #", + line4="delivery instructions", + street_number="25", + city="San Francisco", + state="CA", + postal_code="94104", + country="US", + latitude="40.759211", + longitude="-73.984638", + county="Santa Clara", + contact_name="Elon Musk", + salutation="Mr", + phone_number="111-111-1111", + fax="122-111-1111", + email="elon@musk.com", + website="https://elonmusk.com", + row_version="1-12345", + ), + ), + ], + compensations=[ + EmployeeCompensations( + rate=72000, + payment_unit=PaymentUnit("year"), + currency=Currency("USD"), + flsa_status="exempt", + effective_date="2020-08-12", + ), + ], + works_remote=True, + addresses=[ + Address( + id="123", + type="primary", + string="25 Spring Street, Blackburn, VIC 3130", + name="HQ US", + line1="Main street", + line2="apt #", + line3="Suite #", + line4="delivery instructions", + street_number="25", + city="San Francisco", + state="CA", + postal_code="94104", + country="US", + latitude="40.759211", + longitude="-73.984638", + county="Santa Clara", + contact_name="Elon Musk", + salutation="Mr", + phone_number="111-111-1111", + fax="122-111-1111", + email="elon@musk.com", + website="https://elonmusk.com", + row_version="1-12345", + ), + ], + phone_numbers=[ + PhoneNumber( + id="12345", + country_code="1", + area_code="323", + number="111-111-1111", + extension="105", + type="primary", + ), + ], + emails=[ + Email( + id="123", + email="elon@musk.com", + type="primary", + ), + ], + custom_fields=[ + CustomField( + id="2389328923893298", + name="employee_level", + description="Employee Level", + value=None, + ), + ], + social_links=[ + ApplicantSocialLinks( + id="12345", + url="https://www.twitter.com/apideck-io", + type="twitter", + ), + ], + tax_code="1111", + tax_id="234-32-0000", + dietary_preference="Veggie", + food_allergies=["No allergies"], + tags=["New"], + row_version="1-12345", + deleted=True, + ) # Employee | + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + + # example passing only required values which don't have defaults set + try: + # Create Employee + api_response = api_instance.employees_add(employee) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling HrisApi->employees_add: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Create Employee + api_response = api_instance.employees_add(employee, raw=raw, consumer_id=consumer_id, app_id=app_id, service_id=service_id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling HrisApi->employees_add: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **employee** | [**Employee**](Employee.md)| | + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + +### Return type + +[**CreateEmployeeResponse**](CreateEmployeeResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**201** | Employees | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **employees_all** +> GetEmployeesResponse employees_all() + +List Employees + +List Employees + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import hris_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.get_employees_response import GetEmployeesResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.employees_filter import EmployeesFilter +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = hris_api.HrisApi(api_client) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + cursor = "cursor_example" # str, none_type | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. (optional) + limit = 20 # int | Number of records to return (optional) if omitted the server will use the default value of 20 + filter = EmployeesFilter( + company_id="1234", + email="elon@tesla.com", + first_name="Elon", + title="Manager", + last_name="Musk", + manager_id="1234", + employment_status="active", + employee_number="123456-AB", + ) # EmployeesFilter | Apply filters (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + # List Employees + api_response = api_instance.employees_all(raw=raw, consumer_id=consumer_id, app_id=app_id, service_id=service_id, cursor=cursor, limit=limit, filter=filter) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling HrisApi->employees_all: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **cursor** | **str, none_type**| Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | [optional] + **limit** | **int**| Number of records to return | [optional] if omitted the server will use the default value of 20 + **filter** | **EmployeesFilter**| Apply filters | [optional] + +### Return type + +[**GetEmployeesResponse**](GetEmployeesResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Employees | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **employees_delete** +> DeleteEmployeeResponse employees_delete(id) + +Delete Employee + +Delete Employee + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import hris_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.delete_employee_response import DeleteEmployeeResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = hris_api.HrisApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # Delete Employee + api_response = api_instance.employees_delete(id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling HrisApi->employees_delete: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Delete Employee + api_response = api_instance.employees_delete(id, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling HrisApi->employees_delete: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + +### Return type + +[**DeleteEmployeeResponse**](DeleteEmployeeResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Employees | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **employees_one** +> GetEmployeeResponse employees_one(id) + +Get Employee + +Get Employee + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import hris_api +from apideck.model.get_employee_response import GetEmployeeResponse +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = hris_api.HrisApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # Get Employee + api_response = api_instance.employees_one(id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling HrisApi->employees_one: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get Employee + api_response = api_instance.employees_one(id, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling HrisApi->employees_one: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + +### Return type + +[**GetEmployeeResponse**](GetEmployeeResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Employees | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **employees_update** +> UpdateEmployeeResponse employees_update(id, employee) + +Update Employee + +Update Employee + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import hris_api +from apideck.model.employee import Employee +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.update_employee_response import UpdateEmployeeResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = hris_api.HrisApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + employee = Employee( + first_name="Elon", + last_name="Musk", + middle_name="D.", + display_name="Technoking", + preferred_name="Elon Musk", + initials="EM", + salutation="Mr", + title="CEO", + marital_status="married", + partner=EmployeePartner( + first_name="Elon", + last_name="Musk", + middle_name="D.", + gender=Gender("male"), + initials="EM", + birthday=dateutil_parser('Sat Aug 12 02:00:00 CEST 2000').date(), + deceased_on=dateutil_parser('Sat Aug 12 02:00:00 CEST 2000').date(), + ), + division="Europe", + division_id="12345", + department="R&D", + department_id="12345", + team=EmployeeTeam( + id="1234", + name="Full Stack Engineers", + ), + company_id="23456", + company_name="SpaceX", + employment_start_date="2021-10-26", + employment_end_date="2028-10-26", + leaving_reason="active", + employee_number="123456-AB", + employment_status="active", + employment_role=EmployeeEmploymentRole( + type="contractor", + sub_type="full_time", + ), + manager=EmployeeManager( + name="Elon Musk", + first_name="Elon", + last_name="Musk", + email="elon@musk.com", + ), + direct_reports=["a0d636c6-43b3-4bde-8c70-85b707d992f4","a98lfd96-43b3-4bde-8c70-85b707d992e6"], + social_security_number="123456789", + birthday=dateutil_parser('Sat Aug 12 02:00:00 CEST 2000').date(), + deceased_on=dateutil_parser('Sat Aug 12 02:00:00 CEST 2000').date(), + country_of_birth="US", + description="A description", + gender=Gender("male"), + pronouns="she,her", + preferred_language="EN", + languages=[ + "EN", + ], + nationalities=[ + "US", + ], + photo_url="https://unavatar.io/elon-musk", + timezone="Europe/London", + source="lever", + source_id="12345", + record_url="https://app.intercom.io/contacts/12345", + jobs=[ + EmployeeJobs( + title="CEO", + role="Sales", + start_date=dateutil_parser('Wed Aug 12 02:00:00 CEST 2020').date(), + end_date=dateutil_parser('Wed Aug 12 02:00:00 CEST 2020').date(), + compensation_rate=72000, + currency=Currency("USD"), + payment_unit=PaymentUnit("year"), + hired_at=dateutil_parser('Wed Aug 12 02:00:00 CEST 2020').date(), + is_primary=True, + location=Address( + id="123", + type="primary", + string="25 Spring Street, Blackburn, VIC 3130", + name="HQ US", + line1="Main street", + line2="apt #", + line3="Suite #", + line4="delivery instructions", + street_number="25", + city="San Francisco", + state="CA", + postal_code="94104", + country="US", + latitude="40.759211", + longitude="-73.984638", + county="Santa Clara", + contact_name="Elon Musk", + salutation="Mr", + phone_number="111-111-1111", + fax="122-111-1111", + email="elon@musk.com", + website="https://elonmusk.com", + row_version="1-12345", + ), + ), + ], + compensations=[ + EmployeeCompensations( + rate=72000, + payment_unit=PaymentUnit("year"), + currency=Currency("USD"), + flsa_status="exempt", + effective_date="2020-08-12", + ), + ], + works_remote=True, + addresses=[ + Address( + id="123", + type="primary", + string="25 Spring Street, Blackburn, VIC 3130", + name="HQ US", + line1="Main street", + line2="apt #", + line3="Suite #", + line4="delivery instructions", + street_number="25", + city="San Francisco", + state="CA", + postal_code="94104", + country="US", + latitude="40.759211", + longitude="-73.984638", + county="Santa Clara", + contact_name="Elon Musk", + salutation="Mr", + phone_number="111-111-1111", + fax="122-111-1111", + email="elon@musk.com", + website="https://elonmusk.com", + row_version="1-12345", + ), + ], + phone_numbers=[ + PhoneNumber( + id="12345", + country_code="1", + area_code="323", + number="111-111-1111", + extension="105", + type="primary", + ), + ], + emails=[ + Email( + id="123", + email="elon@musk.com", + type="primary", + ), + ], + custom_fields=[ + CustomField( + id="2389328923893298", + name="employee_level", + description="Employee Level", + value=None, + ), + ], + social_links=[ + ApplicantSocialLinks( + id="12345", + url="https://www.twitter.com/apideck-io", + type="twitter", + ), + ], + tax_code="1111", + tax_id="234-32-0000", + dietary_preference="Veggie", + food_allergies=["No allergies"], + tags=["New"], + row_version="1-12345", + deleted=True, + ) # Employee | + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # Update Employee + api_response = api_instance.employees_update(id, employee) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling HrisApi->employees_update: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Update Employee + api_response = api_instance.employees_update(id, employee, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling HrisApi->employees_update: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **employee** | [**Employee**](Employee.md)| | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + +### Return type + +[**UpdateEmployeeResponse**](UpdateEmployeeResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Employees | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **jobs_all** +> GetHrisJobsResponse jobs_all(employee_id) + +List Jobs + +List Jobs for employee. + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import hris_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.get_hris_jobs_response import GetHrisJobsResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = hris_api.HrisApi(api_client) + employee_id = "employee_id_example" # str | ID of the employee you are acting upon. + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + + # example passing only required values which don't have defaults set + try: + # List Jobs + api_response = api_instance.jobs_all(employee_id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling HrisApi->jobs_all: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # List Jobs + api_response = api_instance.jobs_all(employee_id, raw=raw, consumer_id=consumer_id, app_id=app_id, service_id=service_id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling HrisApi->jobs_all: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **employee_id** | **str**| ID of the employee you are acting upon. | + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + +### Return type + +[**GetHrisJobsResponse**](GetHrisJobsResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Jobs | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **jobs_one** +> GetHrisJobResponse jobs_one(job_id, employee_id) + +One Job + +A Job for employee. + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import hris_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.get_hris_job_response import GetHrisJobResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = hris_api.HrisApi(api_client) + job_id = "job_id_example" # str | ID of the job you are acting upon. + employee_id = "employee_id_example" # str | ID of the employee you are acting upon. + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + + # example passing only required values which don't have defaults set + try: + # One Job + api_response = api_instance.jobs_one(job_id, employee_id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling HrisApi->jobs_one: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # One Job + api_response = api_instance.jobs_one(job_id, employee_id, raw=raw, consumer_id=consumer_id, app_id=app_id, service_id=service_id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling HrisApi->jobs_one: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **job_id** | **str**| ID of the job you are acting upon. | + **employee_id** | **str**| ID of the employee you are acting upon. | + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + +### Return type + +[**GetHrisJobResponse**](GetHrisJobResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Job | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **payrolls_all** +> GetPayrollsResponse payrolls_all() + +List Payroll + +List Payroll + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import hris_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.payrolls_filter import PayrollsFilter +from apideck.model.get_payrolls_response import GetPayrollsResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = hris_api.HrisApi(api_client) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + filter = PayrollsFilter( + start_date="2022-04-08", + end_date="2022-04-21", + ) # PayrollsFilter | Apply filters (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + # List Payroll + api_response = api_instance.payrolls_all(raw=raw, consumer_id=consumer_id, app_id=app_id, service_id=service_id, filter=filter) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling HrisApi->payrolls_all: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **filter** | **PayrollsFilter**| Apply filters | [optional] + +### Return type + +[**GetPayrollsResponse**](GetPayrollsResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Payrolls | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **payrolls_one** +> GetPayrollResponse payrolls_one(payroll_id) + +Get Payroll + +Get Payroll + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import hris_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.get_payroll_response import GetPayrollResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = hris_api.HrisApi(api_client) + payroll_id = "payroll_id_example" # str | ID of the payroll you are acting upon. + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + + # example passing only required values which don't have defaults set + try: + # Get Payroll + api_response = api_instance.payrolls_one(payroll_id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling HrisApi->payrolls_one: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get Payroll + api_response = api_instance.payrolls_one(payroll_id, raw=raw, consumer_id=consumer_id, app_id=app_id, service_id=service_id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling HrisApi->payrolls_one: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **payroll_id** | **str**| ID of the payroll you are acting upon. | + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + +### Return type + +[**GetPayrollResponse**](GetPayrollResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Payrolls | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **time_off_requests_add** +> CreateTimeOffRequestResponse time_off_requests_add(time_off_request) + +Create Time Off Request + +Create Time Off Request + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import hris_api +from apideck.model.create_time_off_request_response import CreateTimeOffRequestResponse +from apideck.model.time_off_request import TimeOffRequest +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = hris_api.HrisApi(api_client) + time_off_request = TimeOffRequest( + employee_id="12345", + policy_id="12345", + status="approved", + description="Enjoying some sun.", + start_date="2022-04-01", + end_date="2022-04-01", + request_date="2022-03-21", + request_type="vacation", + approval_date="2022-03-21", + units="hours", + amount=3.5, + notes=TimeOffRequestNotes( + employee="Relaxing on the beach for a few hours.", + manager="Enjoy!", + ), + ) # TimeOffRequest | + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + + # example passing only required values which don't have defaults set + try: + # Create Time Off Request + api_response = api_instance.time_off_requests_add(time_off_request) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling HrisApi->time_off_requests_add: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Create Time Off Request + api_response = api_instance.time_off_requests_add(time_off_request, raw=raw, consumer_id=consumer_id, app_id=app_id, service_id=service_id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling HrisApi->time_off_requests_add: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **time_off_request** | [**TimeOffRequest**](TimeOffRequest.md)| | + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + +### Return type + +[**CreateTimeOffRequestResponse**](CreateTimeOffRequestResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**201** | TimeOffRequests | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **time_off_requests_all** +> GetTimeOffRequestsResponse time_off_requests_all() + +List Time Off Requests + +List Time Off Requests + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import hris_api +from apideck.model.get_time_off_requests_response import GetTimeOffRequestsResponse +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.time_off_requests_filter import TimeOffRequestsFilter +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = hris_api.HrisApi(api_client) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + cursor = "cursor_example" # str, none_type | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. (optional) + limit = 20 # int | Number of records to return (optional) if omitted the server will use the default value of 20 + filter = TimeOffRequestsFilter( + start_date="2022-04-08", + end_date="2022-04-21", + employee_id="1234", + time_off_request_status="", + ) # TimeOffRequestsFilter | Apply filters (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + # List Time Off Requests + api_response = api_instance.time_off_requests_all(raw=raw, consumer_id=consumer_id, app_id=app_id, service_id=service_id, cursor=cursor, limit=limit, filter=filter) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling HrisApi->time_off_requests_all: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **cursor** | **str, none_type**| Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | [optional] + **limit** | **int**| Number of records to return | [optional] if omitted the server will use the default value of 20 + **filter** | **TimeOffRequestsFilter**| Apply filters | [optional] + +### Return type + +[**GetTimeOffRequestsResponse**](GetTimeOffRequestsResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | TimeOffRequests | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **time_off_requests_delete** +> DeleteTimeOffRequestResponse time_off_requests_delete(id) + +Delete Time Off Request + +Delete Time Off Request + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import hris_api +from apideck.model.delete_time_off_request_response import DeleteTimeOffRequestResponse +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = hris_api.HrisApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # Delete Time Off Request + api_response = api_instance.time_off_requests_delete(id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling HrisApi->time_off_requests_delete: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Delete Time Off Request + api_response = api_instance.time_off_requests_delete(id, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling HrisApi->time_off_requests_delete: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + +### Return type + +[**DeleteTimeOffRequestResponse**](DeleteTimeOffRequestResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | TimeOffRequests | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **time_off_requests_one** +> GetTimeOffRequestResponse time_off_requests_one(id) + +Get Time Off Request + +Get Time Off Request + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import hris_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.get_time_off_request_response import GetTimeOffRequestResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = hris_api.HrisApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # Get Time Off Request + api_response = api_instance.time_off_requests_one(id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling HrisApi->time_off_requests_one: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get Time Off Request + api_response = api_instance.time_off_requests_one(id, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling HrisApi->time_off_requests_one: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + +### Return type + +[**GetTimeOffRequestResponse**](GetTimeOffRequestResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | TimeOffRequests | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **time_off_requests_update** +> UpdateTimeOffRequestResponse time_off_requests_update(id, time_off_request) + +Update Time Off Request + +Update Time Off Request + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import hris_api +from apideck.model.time_off_request import TimeOffRequest +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.update_time_off_request_response import UpdateTimeOffRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = hris_api.HrisApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + time_off_request = TimeOffRequest( + employee_id="12345", + policy_id="12345", + status="approved", + description="Enjoying some sun.", + start_date="2022-04-01", + end_date="2022-04-01", + request_date="2022-03-21", + request_type="vacation", + approval_date="2022-03-21", + units="hours", + amount=3.5, + notes=TimeOffRequestNotes( + employee="Relaxing on the beach for a few hours.", + manager="Enjoy!", + ), + ) # TimeOffRequest | + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # Update Time Off Request + api_response = api_instance.time_off_requests_update(id, time_off_request) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling HrisApi->time_off_requests_update: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Update Time Off Request + api_response = api_instance.time_off_requests_update(id, time_off_request, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling HrisApi->time_off_requests_update: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **time_off_request** | [**TimeOffRequest**](TimeOffRequest.md)| | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + +### Return type + +[**UpdateTimeOffRequestResponse**](UpdateTimeOffRequestResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | TimeOffRequests | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + diff --git a/docs/apis/LeadApi.md b/docs/apis/LeadApi.md new file mode 100644 index 0000000000..92ff735c70 --- /dev/null +++ b/docs/apis/LeadApi.md @@ -0,0 +1,728 @@ +# apideck.LeadApi + +All URIs are relative to *https://unify.apideck.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**leads_add**](LeadApi.md#leads_add) | **POST** /lead/leads | Create lead +[**leads_all**](LeadApi.md#leads_all) | **GET** /lead/leads | List leads +[**leads_delete**](LeadApi.md#leads_delete) | **DELETE** /lead/leads/{id} | Delete lead +[**leads_one**](LeadApi.md#leads_one) | **GET** /lead/leads/{id} | Get lead +[**leads_update**](LeadApi.md#leads_update) | **PATCH** /lead/leads/{id} | Update lead + + +# **leads_add** +> CreateLeadResponse leads_add(lead) + +Create lead + +Create lead + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import lead_api +from apideck.model.create_lead_response import CreateLeadResponse +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.lead import Lead +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = lead_api.LeadApi(api_client) + lead = Lead( + name="Elon Musk", + company_name="Spacex", + owner_id="54321", + company_id="2", + contact_id="2", + lead_source="Cold Call", + first_name="Elon", + last_name="Musk", + description="A thinker", + prefix="Sir", + title="CEO", + language="EN", + status="New", + monetary_amount=75000, + currency=Currency("USD"), + fax="+12129876543", + websites=[ + Website( + id="12345", + url="http://example.com", + type="primary", + ), + ], + addresses=[ + Address( + id="123", + type="primary", + string="25 Spring Street, Blackburn, VIC 3130", + name="HQ US", + line1="Main street", + line2="apt #", + line3="Suite #", + line4="delivery instructions", + street_number="25", + city="San Francisco", + state="CA", + postal_code="94104", + country="US", + latitude="40.759211", + longitude="-73.984638", + county="Santa Clara", + contact_name="Elon Musk", + salutation="Mr", + phone_number="111-111-1111", + fax="122-111-1111", + email="elon@musk.com", + website="https://elonmusk.com", + row_version="1-12345", + ), + ], + social_links=[ + SocialLink( + id="12345", + url="https://www.twitter.com/apideck-io", + type="twitter", + ), + ], + phone_numbers=[ + PhoneNumber( + id="12345", + country_code="1", + area_code="323", + number="111-111-1111", + extension="105", + type="primary", + ), + ], + emails=[ + Email( + id="123", + email="elon@musk.com", + type="primary", + ), + ], + custom_fields=[ + CustomField( + id="2389328923893298", + name="employee_level", + description="Employee Level", + value=None, + ), + ], + tags=Tags(["New"]), + ) # Lead | + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + + # example passing only required values which don't have defaults set + try: + # Create lead + api_response = api_instance.leads_add(lead) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling LeadApi->leads_add: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Create lead + api_response = api_instance.leads_add(lead, raw=raw, consumer_id=consumer_id, app_id=app_id, service_id=service_id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling LeadApi->leads_add: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **lead** | [**Lead**](Lead.md)| | + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + +### Return type + +[**CreateLeadResponse**](CreateLeadResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**201** | Lead created | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **leads_all** +> GetLeadsResponse leads_all() + +List leads + +List leads + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import lead_api +from apideck.model.leads_filter import LeadsFilter +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.get_leads_response import GetLeadsResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.leads_sort import LeadsSort +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = lead_api.LeadApi(api_client) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + cursor = "cursor_example" # str, none_type | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. (optional) + limit = 20 # int | Number of records to return (optional) if omitted the server will use the default value of 20 + filter = LeadsFilter( + name="Elon Musk", + first_name="Elon", + last_name="Musk", + email="elon@tesla.com", + ) # LeadsFilter | Apply filters (optional) + sort = LeadsSort( + by="created_at", + direction=SortDirection("asc"), + ) # LeadsSort | Apply sorting (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + # List leads + api_response = api_instance.leads_all(raw=raw, consumer_id=consumer_id, app_id=app_id, service_id=service_id, cursor=cursor, limit=limit, filter=filter, sort=sort) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling LeadApi->leads_all: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **cursor** | **str, none_type**| Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | [optional] + **limit** | **int**| Number of records to return | [optional] if omitted the server will use the default value of 20 + **filter** | **LeadsFilter**| Apply filters | [optional] + **sort** | **LeadsSort**| Apply sorting | [optional] + +### Return type + +[**GetLeadsResponse**](GetLeadsResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Leads | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **leads_delete** +> DeleteLeadResponse leads_delete(id) + +Delete lead + +Delete lead + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import lead_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.delete_lead_response import DeleteLeadResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = lead_api.LeadApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # Delete lead + api_response = api_instance.leads_delete(id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling LeadApi->leads_delete: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Delete lead + api_response = api_instance.leads_delete(id, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling LeadApi->leads_delete: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + +### Return type + +[**DeleteLeadResponse**](DeleteLeadResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Lead deleted | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **leads_one** +> GetLeadResponse leads_one(id) + +Get lead + +Get lead + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import lead_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.get_lead_response import GetLeadResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = lead_api.LeadApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # Get lead + api_response = api_instance.leads_one(id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling LeadApi->leads_one: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get lead + api_response = api_instance.leads_one(id, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling LeadApi->leads_one: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + +### Return type + +[**GetLeadResponse**](GetLeadResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Lead | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **leads_update** +> UpdateLeadResponse leads_update(id, lead) + +Update lead + +Update lead + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import lead_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.update_lead_response import UpdateLeadResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.lead import Lead +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = lead_api.LeadApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + lead = Lead( + name="Elon Musk", + company_name="Spacex", + owner_id="54321", + company_id="2", + contact_id="2", + lead_source="Cold Call", + first_name="Elon", + last_name="Musk", + description="A thinker", + prefix="Sir", + title="CEO", + language="EN", + status="New", + monetary_amount=75000, + currency=Currency("USD"), + fax="+12129876543", + websites=[ + Website( + id="12345", + url="http://example.com", + type="primary", + ), + ], + addresses=[ + Address( + id="123", + type="primary", + string="25 Spring Street, Blackburn, VIC 3130", + name="HQ US", + line1="Main street", + line2="apt #", + line3="Suite #", + line4="delivery instructions", + street_number="25", + city="San Francisco", + state="CA", + postal_code="94104", + country="US", + latitude="40.759211", + longitude="-73.984638", + county="Santa Clara", + contact_name="Elon Musk", + salutation="Mr", + phone_number="111-111-1111", + fax="122-111-1111", + email="elon@musk.com", + website="https://elonmusk.com", + row_version="1-12345", + ), + ], + social_links=[ + SocialLink( + id="12345", + url="https://www.twitter.com/apideck-io", + type="twitter", + ), + ], + phone_numbers=[ + PhoneNumber( + id="12345", + country_code="1", + area_code="323", + number="111-111-1111", + extension="105", + type="primary", + ), + ], + emails=[ + Email( + id="123", + email="elon@musk.com", + type="primary", + ), + ], + custom_fields=[ + CustomField( + id="2389328923893298", + name="employee_level", + description="Employee Level", + value=None, + ), + ], + tags=Tags(["New"]), + ) # Lead | + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # Update lead + api_response = api_instance.leads_update(id, lead) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling LeadApi->leads_update: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Update lead + api_response = api_instance.leads_update(id, lead, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling LeadApi->leads_update: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **lead** | [**Lead**](Lead.md)| | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + +### Return type + +[**UpdateLeadResponse**](UpdateLeadResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Lead updated | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + diff --git a/docs/apis/PosApi.md b/docs/apis/PosApi.md new file mode 100644 index 0000000000..66a11f5481 --- /dev/null +++ b/docs/apis/PosApi.md @@ -0,0 +1,6159 @@ +# apideck.PosApi + +All URIs are relative to *https://unify.apideck.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**items_add**](PosApi.md#items_add) | **POST** /pos/items | Create Item +[**items_all**](PosApi.md#items_all) | **GET** /pos/items | List Items +[**items_delete**](PosApi.md#items_delete) | **DELETE** /pos/items/{id} | Delete Item +[**items_one**](PosApi.md#items_one) | **GET** /pos/items/{id} | Get Item +[**items_update**](PosApi.md#items_update) | **PATCH** /pos/items/{id} | Update Item +[**locations_add**](PosApi.md#locations_add) | **POST** /pos/locations | Create Location +[**locations_all**](PosApi.md#locations_all) | **GET** /pos/locations | List Locations +[**locations_delete**](PosApi.md#locations_delete) | **DELETE** /pos/locations/{id} | Delete Location +[**locations_one**](PosApi.md#locations_one) | **GET** /pos/locations/{id} | Get Location +[**locations_update**](PosApi.md#locations_update) | **PATCH** /pos/locations/{id} | Update Location +[**merchants_add**](PosApi.md#merchants_add) | **POST** /pos/merchants | Create Merchant +[**merchants_all**](PosApi.md#merchants_all) | **GET** /pos/merchants | List Merchants +[**merchants_delete**](PosApi.md#merchants_delete) | **DELETE** /pos/merchants/{id} | Delete Merchant +[**merchants_one**](PosApi.md#merchants_one) | **GET** /pos/merchants/{id} | Get Merchant +[**merchants_update**](PosApi.md#merchants_update) | **PATCH** /pos/merchants/{id} | Update Merchant +[**modifier_groups_add**](PosApi.md#modifier_groups_add) | **POST** /pos/modifier-groups | Create Modifier Group +[**modifier_groups_all**](PosApi.md#modifier_groups_all) | **GET** /pos/modifier-groups | List Modifier Groups +[**modifier_groups_delete**](PosApi.md#modifier_groups_delete) | **DELETE** /pos/modifier-groups/{id} | Delete Modifier Group +[**modifier_groups_one**](PosApi.md#modifier_groups_one) | **GET** /pos/modifier-groups/{id} | Get Modifier Group +[**modifier_groups_update**](PosApi.md#modifier_groups_update) | **PATCH** /pos/modifier-groups/{id} | Update Modifier Group +[**modifiers_add**](PosApi.md#modifiers_add) | **POST** /pos/modifiers | Create Modifier +[**modifiers_all**](PosApi.md#modifiers_all) | **GET** /pos/modifiers | List Modifiers +[**modifiers_delete**](PosApi.md#modifiers_delete) | **DELETE** /pos/modifiers/{id} | Delete Modifier +[**modifiers_one**](PosApi.md#modifiers_one) | **GET** /pos/modifiers/{id} | Get Modifier +[**modifiers_update**](PosApi.md#modifiers_update) | **PATCH** /pos/modifiers/{id} | Update Modifier +[**order_types_add**](PosApi.md#order_types_add) | **POST** /pos/order-types | Create Order Type +[**order_types_all**](PosApi.md#order_types_all) | **GET** /pos/order-types | List Order Types +[**order_types_delete**](PosApi.md#order_types_delete) | **DELETE** /pos/order-types/{id} | Delete Order Type +[**order_types_one**](PosApi.md#order_types_one) | **GET** /pos/order-types/{id} | Get Order Type +[**order_types_update**](PosApi.md#order_types_update) | **PATCH** /pos/order-types/{id} | Update Order Type +[**orders_add**](PosApi.md#orders_add) | **POST** /pos/orders | Create Order +[**orders_all**](PosApi.md#orders_all) | **GET** /pos/orders | List Orders +[**orders_delete**](PosApi.md#orders_delete) | **DELETE** /pos/orders/{id} | Delete Order +[**orders_one**](PosApi.md#orders_one) | **GET** /pos/orders/{id} | Get Order +[**orders_pay**](PosApi.md#orders_pay) | **POST** /pos/orders/{id}/pay | Pay Order +[**orders_update**](PosApi.md#orders_update) | **PATCH** /pos/orders/{id} | Update Order +[**payments_add**](PosApi.md#payments_add) | **POST** /pos/payments | Create Payment +[**payments_all**](PosApi.md#payments_all) | **GET** /pos/payments | List Payments +[**payments_delete**](PosApi.md#payments_delete) | **DELETE** /pos/payments/{id} | Delete Payment +[**payments_one**](PosApi.md#payments_one) | **GET** /pos/payments/{id} | Get Payment +[**payments_update**](PosApi.md#payments_update) | **PATCH** /pos/payments/{id} | Update Payment +[**tenders_add**](PosApi.md#tenders_add) | **POST** /pos/tenders | Create Tender +[**tenders_all**](PosApi.md#tenders_all) | **GET** /pos/tenders | List Tenders +[**tenders_delete**](PosApi.md#tenders_delete) | **DELETE** /pos/tenders/{id} | Delete Tender +[**tenders_one**](PosApi.md#tenders_one) | **GET** /pos/tenders/{id} | Get Tender +[**tenders_update**](PosApi.md#tenders_update) | **PATCH** /pos/tenders/{id} | Update Tender + + +# **items_add** +> CreateItemResponse items_add(item) + +Create Item + +Create Item + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import pos_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.item import Item +from apideck.model.create_item_response import CreateItemResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = pos_api.PosApi(api_client) + item = Item( + id="#cocoa", + idempotency_key=IdempotencyKey("random_string"), + name="Cocoa", + description="Hot Chocolate", + abbreviation="Ch", + product_type="regular", + price_amount=10, + pricing_type="fixed", + price_currency=Currency("USD"), + cost=2, + tax_ids=["12345","67890"], + absent_at_location_ids=["12345","67890"], + present_at_all_locations=False, + available_for_pickup=False, + available_online=False, + sku="11910345", + code="11910345", + categories=[{"id":"12345","name":"Food","image_ids":["12345","67890"]}], + options=[ + None, + ], + variations=[{"id":"12345","name":"Food","sku":"11910345","item_id":"12345","sequence":0,"pricing_type":"fixed","price_amount":10,"price_currency":"USD","image_ids":["12345","67890"]}], + modifier_groups=[{"id":"12345"}], + available=True, + hidden=True, + deleted=True, + ) # Item | + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + + # example passing only required values which don't have defaults set + try: + # Create Item + api_response = api_instance.items_add(item) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling PosApi->items_add: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Create Item + api_response = api_instance.items_add(item, raw=raw, consumer_id=consumer_id, app_id=app_id, service_id=service_id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling PosApi->items_add: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **item** | [**Item**](Item.md)| | + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + +### Return type + +[**CreateItemResponse**](CreateItemResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**201** | Items | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **items_all** +> GetItemsResponse items_all() + +List Items + +List Items + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import pos_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.get_items_response import GetItemsResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = pos_api.PosApi(api_client) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + cursor = "cursor_example" # str, none_type | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. (optional) + limit = 20 # int | Number of records to return (optional) if omitted the server will use the default value of 20 + + # example passing only required values which don't have defaults set + # and optional values + try: + # List Items + api_response = api_instance.items_all(raw=raw, consumer_id=consumer_id, app_id=app_id, service_id=service_id, cursor=cursor, limit=limit) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling PosApi->items_all: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **cursor** | **str, none_type**| Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | [optional] + **limit** | **int**| Number of records to return | [optional] if omitted the server will use the default value of 20 + +### Return type + +[**GetItemsResponse**](GetItemsResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Items | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **items_delete** +> DeleteItemResponse items_delete(id) + +Delete Item + +Delete Item + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import pos_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.delete_item_response import DeleteItemResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = pos_api.PosApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # Delete Item + api_response = api_instance.items_delete(id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling PosApi->items_delete: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Delete Item + api_response = api_instance.items_delete(id, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling PosApi->items_delete: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + +### Return type + +[**DeleteItemResponse**](DeleteItemResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Items | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **items_one** +> GetItemResponse items_one(id) + +Get Item + +Get Item + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import pos_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.get_item_response import GetItemResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = pos_api.PosApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # Get Item + api_response = api_instance.items_one(id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling PosApi->items_one: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get Item + api_response = api_instance.items_one(id, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling PosApi->items_one: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + +### Return type + +[**GetItemResponse**](GetItemResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Items | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **items_update** +> UpdateItemResponse items_update(id, item) + +Update Item + +Update Item + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import pos_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.item import Item +from apideck.model.update_item_response import UpdateItemResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = pos_api.PosApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + item = Item( + id="#cocoa", + idempotency_key=IdempotencyKey("random_string"), + name="Cocoa", + description="Hot Chocolate", + abbreviation="Ch", + product_type="regular", + price_amount=10, + pricing_type="fixed", + price_currency=Currency("USD"), + cost=2, + tax_ids=["12345","67890"], + absent_at_location_ids=["12345","67890"], + present_at_all_locations=False, + available_for_pickup=False, + available_online=False, + sku="11910345", + code="11910345", + categories=[{"id":"12345","name":"Food","image_ids":["12345","67890"]}], + options=[ + None, + ], + variations=[{"id":"12345","name":"Food","sku":"11910345","item_id":"12345","sequence":0,"pricing_type":"fixed","price_amount":10,"price_currency":"USD","image_ids":["12345","67890"]}], + modifier_groups=[{"id":"12345"}], + available=True, + hidden=True, + deleted=True, + ) # Item | + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # Update Item + api_response = api_instance.items_update(id, item) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling PosApi->items_update: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Update Item + api_response = api_instance.items_update(id, item, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling PosApi->items_update: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **item** | [**Item**](Item.md)| | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + +### Return type + +[**UpdateItemResponse**](UpdateItemResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Items | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **locations_add** +> CreateLocationResponse locations_add(location) + +Create Location + +Create Location + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import pos_api +from apideck.model.location import Location +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.create_location_response import CreateLocationResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = pos_api.PosApi(api_client) + location = Location( + name="Dunkin Donuts", + business_name="Dunkin Donuts LLC", + address=Address( + id="123", + type="primary", + string="25 Spring Street, Blackburn, VIC 3130", + name="HQ US", + line1="Main street", + line2="apt #", + line3="Suite #", + line4="delivery instructions", + street_number="25", + city="San Francisco", + state="CA", + postal_code="94104", + country="US", + latitude="40.759211", + longitude="-73.984638", + county="Santa Clara", + contact_name="Elon Musk", + salutation="Mr", + phone_number="111-111-1111", + fax="122-111-1111", + email="elon@musk.com", + website="https://elonmusk.com", + row_version="1-12345", + ), + status="active", + merchant_id="12345", + currency=Currency("USD"), + ) # Location | + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + + # example passing only required values which don't have defaults set + try: + # Create Location + api_response = api_instance.locations_add(location) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling PosApi->locations_add: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Create Location + api_response = api_instance.locations_add(location, raw=raw, consumer_id=consumer_id, app_id=app_id, service_id=service_id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling PosApi->locations_add: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **location** | [**Location**](Location.md)| | + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + +### Return type + +[**CreateLocationResponse**](CreateLocationResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**201** | Locations | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **locations_all** +> GetLocationsResponse locations_all() + +List Locations + +List Locations + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import pos_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.get_locations_response import GetLocationsResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = pos_api.PosApi(api_client) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + cursor = "cursor_example" # str, none_type | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. (optional) + limit = 20 # int | Number of records to return (optional) if omitted the server will use the default value of 20 + + # example passing only required values which don't have defaults set + # and optional values + try: + # List Locations + api_response = api_instance.locations_all(raw=raw, consumer_id=consumer_id, app_id=app_id, service_id=service_id, cursor=cursor, limit=limit) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling PosApi->locations_all: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **cursor** | **str, none_type**| Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | [optional] + **limit** | **int**| Number of records to return | [optional] if omitted the server will use the default value of 20 + +### Return type + +[**GetLocationsResponse**](GetLocationsResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Locations | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **locations_delete** +> DeleteLocationResponse locations_delete(id) + +Delete Location + +Delete Location + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import pos_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.delete_location_response import DeleteLocationResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = pos_api.PosApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # Delete Location + api_response = api_instance.locations_delete(id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling PosApi->locations_delete: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Delete Location + api_response = api_instance.locations_delete(id, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling PosApi->locations_delete: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + +### Return type + +[**DeleteLocationResponse**](DeleteLocationResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Locations | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **locations_one** +> GetLocationResponse locations_one(id) + +Get Location + +Get Location + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import pos_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.get_location_response import GetLocationResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = pos_api.PosApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # Get Location + api_response = api_instance.locations_one(id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling PosApi->locations_one: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get Location + api_response = api_instance.locations_one(id, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling PosApi->locations_one: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + +### Return type + +[**GetLocationResponse**](GetLocationResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Locations | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **locations_update** +> UpdateLocationResponse locations_update(id, location) + +Update Location + +Update Location + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import pos_api +from apideck.model.update_location_response import UpdateLocationResponse +from apideck.model.location import Location +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = pos_api.PosApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + location = Location( + name="Dunkin Donuts", + business_name="Dunkin Donuts LLC", + address=Address( + id="123", + type="primary", + string="25 Spring Street, Blackburn, VIC 3130", + name="HQ US", + line1="Main street", + line2="apt #", + line3="Suite #", + line4="delivery instructions", + street_number="25", + city="San Francisco", + state="CA", + postal_code="94104", + country="US", + latitude="40.759211", + longitude="-73.984638", + county="Santa Clara", + contact_name="Elon Musk", + salutation="Mr", + phone_number="111-111-1111", + fax="122-111-1111", + email="elon@musk.com", + website="https://elonmusk.com", + row_version="1-12345", + ), + status="active", + merchant_id="12345", + currency=Currency("USD"), + ) # Location | + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # Update Location + api_response = api_instance.locations_update(id, location) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling PosApi->locations_update: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Update Location + api_response = api_instance.locations_update(id, location, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling PosApi->locations_update: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **location** | [**Location**](Location.md)| | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + +### Return type + +[**UpdateLocationResponse**](UpdateLocationResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Locations | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **merchants_add** +> CreateMerchantResponse merchants_add(merchant) + +Create Merchant + +Create Merchant + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import pos_api +from apideck.model.create_merchant_response import CreateMerchantResponse +from apideck.model.merchant import Merchant +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = pos_api.PosApi(api_client) + merchant = Merchant( + name="Dunkin Donuts", + address=Address( + id="123", + type="primary", + string="25 Spring Street, Blackburn, VIC 3130", + name="HQ US", + line1="Main street", + line2="apt #", + line3="Suite #", + line4="delivery instructions", + street_number="25", + city="San Francisco", + state="CA", + postal_code="94104", + country="US", + latitude="40.759211", + longitude="-73.984638", + county="Santa Clara", + contact_name="Elon Musk", + salutation="Mr", + phone_number="111-111-1111", + fax="122-111-1111", + email="elon@musk.com", + website="https://elonmusk.com", + row_version="1-12345", + ), + owner_id="12345", + main_location_id="12345", + status="active", + service_charges=[ + ServiceCharge( + name="Charge for delivery", + amount=27500, + percentage=12.5, + currency=Currency("USD"), + active=True, + type="auto_gratuity", + ), + ], + language="EN", + currency=Currency("USD"), + ) # Merchant | + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + + # example passing only required values which don't have defaults set + try: + # Create Merchant + api_response = api_instance.merchants_add(merchant) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling PosApi->merchants_add: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Create Merchant + api_response = api_instance.merchants_add(merchant, raw=raw, consumer_id=consumer_id, app_id=app_id, service_id=service_id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling PosApi->merchants_add: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **merchant** | [**Merchant**](Merchant.md)| | + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + +### Return type + +[**CreateMerchantResponse**](CreateMerchantResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**201** | Merchants | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **merchants_all** +> GetMerchantsResponse merchants_all() + +List Merchants + +List Merchants + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import pos_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.get_merchants_response import GetMerchantsResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = pos_api.PosApi(api_client) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + cursor = "cursor_example" # str, none_type | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. (optional) + limit = 20 # int | Number of records to return (optional) if omitted the server will use the default value of 20 + + # example passing only required values which don't have defaults set + # and optional values + try: + # List Merchants + api_response = api_instance.merchants_all(raw=raw, consumer_id=consumer_id, app_id=app_id, service_id=service_id, cursor=cursor, limit=limit) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling PosApi->merchants_all: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **cursor** | **str, none_type**| Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | [optional] + **limit** | **int**| Number of records to return | [optional] if omitted the server will use the default value of 20 + +### Return type + +[**GetMerchantsResponse**](GetMerchantsResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Merchants | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **merchants_delete** +> DeleteMerchantResponse merchants_delete(id) + +Delete Merchant + +Delete Merchant + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import pos_api +from apideck.model.delete_merchant_response import DeleteMerchantResponse +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = pos_api.PosApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # Delete Merchant + api_response = api_instance.merchants_delete(id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling PosApi->merchants_delete: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Delete Merchant + api_response = api_instance.merchants_delete(id, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling PosApi->merchants_delete: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + +### Return type + +[**DeleteMerchantResponse**](DeleteMerchantResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Merchants | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **merchants_one** +> GetMerchantResponse merchants_one(id) + +Get Merchant + +Get Merchant + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import pos_api +from apideck.model.get_merchant_response import GetMerchantResponse +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = pos_api.PosApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # Get Merchant + api_response = api_instance.merchants_one(id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling PosApi->merchants_one: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get Merchant + api_response = api_instance.merchants_one(id, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling PosApi->merchants_one: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + +### Return type + +[**GetMerchantResponse**](GetMerchantResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Merchants | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **merchants_update** +> UpdateMerchantResponse merchants_update(id, merchant) + +Update Merchant + +Update Merchant + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import pos_api +from apideck.model.merchant import Merchant +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.update_merchant_response import UpdateMerchantResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = pos_api.PosApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + merchant = Merchant( + name="Dunkin Donuts", + address=Address( + id="123", + type="primary", + string="25 Spring Street, Blackburn, VIC 3130", + name="HQ US", + line1="Main street", + line2="apt #", + line3="Suite #", + line4="delivery instructions", + street_number="25", + city="San Francisco", + state="CA", + postal_code="94104", + country="US", + latitude="40.759211", + longitude="-73.984638", + county="Santa Clara", + contact_name="Elon Musk", + salutation="Mr", + phone_number="111-111-1111", + fax="122-111-1111", + email="elon@musk.com", + website="https://elonmusk.com", + row_version="1-12345", + ), + owner_id="12345", + main_location_id="12345", + status="active", + service_charges=[ + ServiceCharge( + name="Charge for delivery", + amount=27500, + percentage=12.5, + currency=Currency("USD"), + active=True, + type="auto_gratuity", + ), + ], + language="EN", + currency=Currency("USD"), + ) # Merchant | + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # Update Merchant + api_response = api_instance.merchants_update(id, merchant) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling PosApi->merchants_update: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Update Merchant + api_response = api_instance.merchants_update(id, merchant, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling PosApi->merchants_update: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **merchant** | [**Merchant**](Merchant.md)| | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + +### Return type + +[**UpdateMerchantResponse**](UpdateMerchantResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Merchants | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **modifier_groups_add** +> CreateModifierGroupResponse modifier_groups_add(modifier_group) + +Create Modifier Group + +Create Modifier Group + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import pos_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.modifier_group import ModifierGroup +from apideck.model.create_modifier_group_response import CreateModifierGroupResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = pos_api.PosApi(api_client) + modifier_group = ModifierGroup( + name="Modifier", + alternate_name="Modifier New", + minimum_required=1, + maximum_allowed=5, + selection_type="single", + present_at_all_locations=False, + modifiers=[ + None, + ], + deleted=True, + row_version="1-12345", + ) # ModifierGroup | + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + + # example passing only required values which don't have defaults set + try: + # Create Modifier Group + api_response = api_instance.modifier_groups_add(modifier_group) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling PosApi->modifier_groups_add: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Create Modifier Group + api_response = api_instance.modifier_groups_add(modifier_group, raw=raw, consumer_id=consumer_id, app_id=app_id, service_id=service_id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling PosApi->modifier_groups_add: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **modifier_group** | [**ModifierGroup**](ModifierGroup.md)| | + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + +### Return type + +[**CreateModifierGroupResponse**](CreateModifierGroupResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**201** | ModifierGroups | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **modifier_groups_all** +> GetModifierGroupsResponse modifier_groups_all() + +List Modifier Groups + +List Modifier Groups + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import pos_api +from apideck.model.get_modifier_groups_response import GetModifierGroupsResponse +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = pos_api.PosApi(api_client) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + cursor = "cursor_example" # str, none_type | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. (optional) + limit = 20 # int | Number of records to return (optional) if omitted the server will use the default value of 20 + + # example passing only required values which don't have defaults set + # and optional values + try: + # List Modifier Groups + api_response = api_instance.modifier_groups_all(raw=raw, consumer_id=consumer_id, app_id=app_id, service_id=service_id, cursor=cursor, limit=limit) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling PosApi->modifier_groups_all: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **cursor** | **str, none_type**| Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | [optional] + **limit** | **int**| Number of records to return | [optional] if omitted the server will use the default value of 20 + +### Return type + +[**GetModifierGroupsResponse**](GetModifierGroupsResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | ModifierGroups | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **modifier_groups_delete** +> DeleteModifierGroupResponse modifier_groups_delete(id) + +Delete Modifier Group + +Delete Modifier Group + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import pos_api +from apideck.model.delete_modifier_group_response import DeleteModifierGroupResponse +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = pos_api.PosApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # Delete Modifier Group + api_response = api_instance.modifier_groups_delete(id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling PosApi->modifier_groups_delete: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Delete Modifier Group + api_response = api_instance.modifier_groups_delete(id, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling PosApi->modifier_groups_delete: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + +### Return type + +[**DeleteModifierGroupResponse**](DeleteModifierGroupResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | ModifierGroups | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **modifier_groups_one** +> GetModifierGroupResponse modifier_groups_one(id) + +Get Modifier Group + +Get Modifier Group + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import pos_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.get_modifier_group_response import GetModifierGroupResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = pos_api.PosApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # Get Modifier Group + api_response = api_instance.modifier_groups_one(id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling PosApi->modifier_groups_one: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get Modifier Group + api_response = api_instance.modifier_groups_one(id, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling PosApi->modifier_groups_one: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + +### Return type + +[**GetModifierGroupResponse**](GetModifierGroupResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | ModifierGroups | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **modifier_groups_update** +> UpdateModifierGroupResponse modifier_groups_update(id, modifier_group) + +Update Modifier Group + +Update Modifier Group + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import pos_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.update_modifier_group_response import UpdateModifierGroupResponse +from apideck.model.modifier_group import ModifierGroup +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = pos_api.PosApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + modifier_group = ModifierGroup( + name="Modifier", + alternate_name="Modifier New", + minimum_required=1, + maximum_allowed=5, + selection_type="single", + present_at_all_locations=False, + modifiers=[ + None, + ], + deleted=True, + row_version="1-12345", + ) # ModifierGroup | + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # Update Modifier Group + api_response = api_instance.modifier_groups_update(id, modifier_group) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling PosApi->modifier_groups_update: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Update Modifier Group + api_response = api_instance.modifier_groups_update(id, modifier_group, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling PosApi->modifier_groups_update: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **modifier_group** | [**ModifierGroup**](ModifierGroup.md)| | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + +### Return type + +[**UpdateModifierGroupResponse**](UpdateModifierGroupResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | ModifierGroups | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **modifiers_add** +> CreateModifierResponse modifiers_add(modifier) + +Create Modifier + +Create Modifier + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import pos_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.modifier import Modifier +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.create_modifier_response import CreateModifierResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = pos_api.PosApi(api_client) + modifier = Modifier( + idempotency_key=IdempotencyKey("random_string"), + name="Modifier", + alternate_name="Modifier New", + price_amount=10, + currency=Currency("USD"), + modifier_group_id="123", + available=True, + ) # Modifier | + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + + # example passing only required values which don't have defaults set + try: + # Create Modifier + api_response = api_instance.modifiers_add(modifier) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling PosApi->modifiers_add: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Create Modifier + api_response = api_instance.modifiers_add(modifier, raw=raw, consumer_id=consumer_id, app_id=app_id, service_id=service_id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling PosApi->modifiers_add: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **modifier** | [**Modifier**](Modifier.md)| | + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + +### Return type + +[**CreateModifierResponse**](CreateModifierResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**201** | Modifiers | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **modifiers_all** +> GetModifiersResponse modifiers_all() + +List Modifiers + +List Modifiers + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import pos_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.get_modifiers_response import GetModifiersResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = pos_api.PosApi(api_client) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + cursor = "cursor_example" # str, none_type | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. (optional) + limit = 20 # int | Number of records to return (optional) if omitted the server will use the default value of 20 + + # example passing only required values which don't have defaults set + # and optional values + try: + # List Modifiers + api_response = api_instance.modifiers_all(raw=raw, consumer_id=consumer_id, app_id=app_id, service_id=service_id, cursor=cursor, limit=limit) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling PosApi->modifiers_all: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **cursor** | **str, none_type**| Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | [optional] + **limit** | **int**| Number of records to return | [optional] if omitted the server will use the default value of 20 + +### Return type + +[**GetModifiersResponse**](GetModifiersResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Modifiers | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **modifiers_delete** +> DeleteModifierResponse modifiers_delete(id) + +Delete Modifier + +Delete Modifier + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import pos_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.modifier_group_filter import ModifierGroupFilter +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.delete_modifier_response import DeleteModifierResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = pos_api.PosApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + filter = ModifierGroupFilter( + modifier_group_id="1234", + ) # ModifierGroupFilter | Apply filters (optional) + + # example passing only required values which don't have defaults set + try: + # Delete Modifier + api_response = api_instance.modifiers_delete(id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling PosApi->modifiers_delete: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Delete Modifier + api_response = api_instance.modifiers_delete(id, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw, filter=filter) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling PosApi->modifiers_delete: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + **filter** | **ModifierGroupFilter**| Apply filters | [optional] + +### Return type + +[**DeleteModifierResponse**](DeleteModifierResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Modifiers | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **modifiers_one** +> GetModifierResponse modifiers_one(id) + +Get Modifier + +Get Modifier + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import pos_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.get_modifier_response import GetModifierResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.modifier_group_filter import ModifierGroupFilter +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = pos_api.PosApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + filter = ModifierGroupFilter( + modifier_group_id="1234", + ) # ModifierGroupFilter | Apply filters (optional) + + # example passing only required values which don't have defaults set + try: + # Get Modifier + api_response = api_instance.modifiers_one(id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling PosApi->modifiers_one: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get Modifier + api_response = api_instance.modifiers_one(id, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw, filter=filter) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling PosApi->modifiers_one: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + **filter** | **ModifierGroupFilter**| Apply filters | [optional] + +### Return type + +[**GetModifierResponse**](GetModifierResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Modifiers | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **modifiers_update** +> UpdateModifierResponse modifiers_update(id, modifier) + +Update Modifier + +Update Modifier + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import pos_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.modifier import Modifier +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.update_modifier_response import UpdateModifierResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = pos_api.PosApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + modifier = Modifier( + idempotency_key=IdempotencyKey("random_string"), + name="Modifier", + alternate_name="Modifier New", + price_amount=10, + currency=Currency("USD"), + modifier_group_id="123", + available=True, + ) # Modifier | + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # Update Modifier + api_response = api_instance.modifiers_update(id, modifier) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling PosApi->modifiers_update: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Update Modifier + api_response = api_instance.modifiers_update(id, modifier, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling PosApi->modifiers_update: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **modifier** | [**Modifier**](Modifier.md)| | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + +### Return type + +[**UpdateModifierResponse**](UpdateModifierResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Modifiers | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **order_types_add** +> CreateOrderTypeResponse order_types_add(order_type) + +Create Order Type + +Create Order Type + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import pos_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.order_type import OrderType +from apideck.model.create_order_type_response import CreateOrderTypeResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = pos_api.PosApi(api_client) + order_type = OrderType( + name="Default order type", + default=True, + ) # OrderType | + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + + # example passing only required values which don't have defaults set + try: + # Create Order Type + api_response = api_instance.order_types_add(order_type) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling PosApi->order_types_add: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Create Order Type + api_response = api_instance.order_types_add(order_type, raw=raw, consumer_id=consumer_id, app_id=app_id, service_id=service_id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling PosApi->order_types_add: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **order_type** | [**OrderType**](OrderType.md)| | + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + +### Return type + +[**CreateOrderTypeResponse**](CreateOrderTypeResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**201** | OrderTypes | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **order_types_all** +> GetOrderTypesResponse order_types_all() + +List Order Types + +List Order Types + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import pos_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.get_order_types_response import GetOrderTypesResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = pos_api.PosApi(api_client) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + cursor = "cursor_example" # str, none_type | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. (optional) + limit = 20 # int | Number of records to return (optional) if omitted the server will use the default value of 20 + + # example passing only required values which don't have defaults set + # and optional values + try: + # List Order Types + api_response = api_instance.order_types_all(raw=raw, consumer_id=consumer_id, app_id=app_id, service_id=service_id, cursor=cursor, limit=limit) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling PosApi->order_types_all: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **cursor** | **str, none_type**| Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | [optional] + **limit** | **int**| Number of records to return | [optional] if omitted the server will use the default value of 20 + +### Return type + +[**GetOrderTypesResponse**](GetOrderTypesResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OrderTypes | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **order_types_delete** +> DeleteOrderTypeResponse order_types_delete(id) + +Delete Order Type + +Delete Order Type + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import pos_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.delete_order_type_response import DeleteOrderTypeResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = pos_api.PosApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # Delete Order Type + api_response = api_instance.order_types_delete(id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling PosApi->order_types_delete: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Delete Order Type + api_response = api_instance.order_types_delete(id, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling PosApi->order_types_delete: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + +### Return type + +[**DeleteOrderTypeResponse**](DeleteOrderTypeResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OrderTypes | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **order_types_one** +> GetOrderTypeResponse order_types_one(id) + +Get Order Type + +Get Order Type + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import pos_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.get_order_type_response import GetOrderTypeResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = pos_api.PosApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # Get Order Type + api_response = api_instance.order_types_one(id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling PosApi->order_types_one: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get Order Type + api_response = api_instance.order_types_one(id, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling PosApi->order_types_one: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + +### Return type + +[**GetOrderTypeResponse**](GetOrderTypeResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OrderTypes | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **order_types_update** +> UpdateOrderTypeResponse order_types_update(id, order_type) + +Update Order Type + +Update Order Type + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import pos_api +from apideck.model.update_order_type_response import UpdateOrderTypeResponse +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.order_type import OrderType +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = pos_api.PosApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + order_type = OrderType( + name="Default order type", + default=True, + ) # OrderType | + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # Update Order Type + api_response = api_instance.order_types_update(id, order_type) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling PosApi->order_types_update: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Update Order Type + api_response = api_instance.order_types_update(id, order_type, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling PosApi->order_types_update: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **order_type** | [**OrderType**](OrderType.md)| | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + +### Return type + +[**UpdateOrderTypeResponse**](UpdateOrderTypeResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OrderTypes | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **orders_add** +> CreateOrderResponse orders_add(order) + +Create Order + +Create Order + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import pos_api +from apideck.model.create_order_response import CreateOrderResponse +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.order import Order +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = pos_api.PosApi(api_client) + order = Order( + idempotency_key=IdempotencyKey("random_string"), + order_number="1F", + order_date=dateutil_parser('Fri Aug 12 02:00:00 CEST 2022').date(), + closed_date=dateutil_parser('Sat Aug 13 02:00:00 CEST 2022').date(), + reference_id="my-order-001", + status="open", + payment_status="open", + currency=Currency("USD"), + title="title_example", + note="note_example", + merchant_id="12345", + customer_id="12345", + employee_id="12345", + location_id="12345", + order_type_id="12345", + table="1F", + seat="23F", + total_amount=275, + total_tip=700, + total_tax=275, + total_discount=300, + total_refund=0, + total_service_charge=0, + refunded=False, + customers=[ + OrderCustomers( + first_name="Elon", + middle_name="D.", + last_name="Musk", + phone_numbers=[ + PhoneNumber( + id="12345", + country_code="1", + area_code="323", + number="111-111-1111", + extension="105", + type="primary", + ), + ], + emails=[ + Email( + id="123", + email="elon@musk.com", + type="primary", + ), + ], + ), + ], + fulfillments=[ + OrderFulfillments( + id="12345", + status="proposed", + type="shipment", + pickup_details=OrderPickupDetails( + auto_complete_duration="P1W3D", + cancel_reason="Not hungry", + expires_at=dateutil_parser('2016-09-04T23:59:33.123Z'), + schedule_type="scheduled", + pickup_at=dateutil_parser('2016-09-04T23:59:33.123Z'), + pickup_window_duration="P1W3D", + prep_time_duration="P1W3D", + note="Pickup in the back.", + placed_at=dateutil_parser('2016-09-04T23:59:33.123Z'), + rejected_at=dateutil_parser('2016-09-04T23:59:33.123Z'), + ready_at=dateutil_parser('2016-09-04T23:59:33.123Z'), + expired_at=dateutil_parser('2016-09-04T23:59:33.123Z'), + picked_up_at=dateutil_parser('2016-09-04T23:59:33.123Z'), + canceled_at=dateutil_parser('2016-09-04T23:59:33.123Z'), + is_curbside_pickup=True, + curbside_pickup_details=OrderPickupDetailsCurbsidePickupDetails( + curbside_details="curbside_details_example", + buyer_arrived_at=dateutil_parser('2016-09-04T23:59:33.123Z'), + ), + recipient=OrderPickupDetailsRecipient( + customer_id="12345", + display_name="Elon Musk", + address=Address( + id="123", + type="primary", + string="25 Spring Street, Blackburn, VIC 3130", + name="HQ US", + line1="Main street", + line2="apt #", + line3="Suite #", + line4="delivery instructions", + street_number="25", + city="San Francisco", + state="CA", + postal_code="94104", + country="US", + latitude="40.759211", + longitude="-73.984638", + county="Santa Clara", + contact_name="Elon Musk", + salutation="Mr", + phone_number="111-111-1111", + fax="122-111-1111", + email="elon@musk.com", + website="https://elonmusk.com", + row_version="1-12345", + ), + phone_number=PhoneNumber( + id="12345", + country_code="1", + area_code="323", + number="111-111-1111", + extension="105", + type="primary", + ), + email=Email( + id="123", + email="elon@musk.com", + type="primary", + ), + ), + ), + shipment_details={}, + ), + ], + line_items=[ + OrderLineItems( + name="New York Strip Steak", + item=None, + total_tax=2000, + total_discount=3000, + total_amount=27500, + quantity=1, + unit_price=27500.5, + applied_taxes=[ + None, + ], + applied_discounts=[ + None, + ], + modifiers=[ + None, + ], + ), + ], + payments=[ + OrderPayments( + amount=27500, + currency=Currency("USD"), + ), + ], + service_charges=ServiceCharges([ + ServiceCharge( + name="Charge for delivery", + amount=27500, + percentage=12.5, + currency=Currency("USD"), + active=True, + type="auto_gratuity", + ), + ]), + refunds=[ + OrderRefunds( + amount=27500, + currency=Currency("USD"), + reason="The reason for the refund being issued.", + status="pending", + ), + ], + taxes=[ + None, + ], + discounts=[ + OrderDiscounts( + name="10% off", + type="percentage", + amount=27500, + currency=Currency("USD"), + scope="order", + ), + ], + tenders=[ + OrderTenders( + name="10% off", + type="cash", + note="An optional note associated with the tender at the time of payment.", + amount=27500, + percentage=10, + currency=Currency("USD"), + total_amount=1, + total_tip=7, + total_processing_fee=0, + total_tax=1, + total_discount=3, + total_refund=0, + total_service_charge=0, + buyer_tendered_cash_amount=27500, + change_back_cash_amount=27500, + card=PaymentCard( + bin="41111", + card_brand="visa", + card_type="credit", + prepaid_type="prepaid", + cardholder_name="John Doe", + customer_id="12345", + merchant_id="12345", + exp_month=1, + exp_year=2022, + fingerprint=" Intended as a POS-assigned identifier, based on the card number, to identify the card across multiple locations within a single application.", + last_4="The last 4 digits of the card number.", + enabled=True, + billing_address=Address( + id="123", + type="primary", + string="25 Spring Street, Blackburn, VIC 3130", + name="HQ US", + line1="Main street", + line2="apt #", + line3="Suite #", + line4="delivery instructions", + street_number="25", + city="San Francisco", + state="CA", + postal_code="94104", + country="US", + latitude="40.759211", + longitude="-73.984638", + county="Santa Clara", + contact_name="Elon Musk", + salutation="Mr", + phone_number="111-111-1111", + fax="122-111-1111", + email="elon@musk.com", + website="https://elonmusk.com", + row_version="1-12345", + ), + reference_id="card-001", + version="230320320320", + ), + card_status="authorized", + card_entry_method="swiped", + ), + ], + voided=False, + version="230320320320", + ) # Order | + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + + # example passing only required values which don't have defaults set + try: + # Create Order + api_response = api_instance.orders_add(order) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling PosApi->orders_add: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Create Order + api_response = api_instance.orders_add(order, raw=raw, consumer_id=consumer_id, app_id=app_id, service_id=service_id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling PosApi->orders_add: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **order** | [**Order**](Order.md)| | + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + +### Return type + +[**CreateOrderResponse**](CreateOrderResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**201** | Orders | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **orders_all** +> GetOrdersResponse orders_all() + +List Orders + +List Orders + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import pos_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.get_orders_response import GetOrdersResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = pos_api.PosApi(api_client) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + cursor = "cursor_example" # str, none_type | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. (optional) + limit = 20 # int | Number of records to return (optional) if omitted the server will use the default value of 20 + location_id = "location_id_example" # str | ID of the location. (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + # List Orders + api_response = api_instance.orders_all(raw=raw, consumer_id=consumer_id, app_id=app_id, service_id=service_id, cursor=cursor, limit=limit, location_id=location_id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling PosApi->orders_all: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **cursor** | **str, none_type**| Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | [optional] + **limit** | **int**| Number of records to return | [optional] if omitted the server will use the default value of 20 + **location_id** | **str**| ID of the location. | [optional] + +### Return type + +[**GetOrdersResponse**](GetOrdersResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Orders | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **orders_delete** +> DeleteOrderResponse orders_delete(id) + +Delete Order + +Delete Order + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import pos_api +from apideck.model.delete_order_response import DeleteOrderResponse +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = pos_api.PosApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # Delete Order + api_response = api_instance.orders_delete(id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling PosApi->orders_delete: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Delete Order + api_response = api_instance.orders_delete(id, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling PosApi->orders_delete: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + +### Return type + +[**DeleteOrderResponse**](DeleteOrderResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Orders | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **orders_one** +> GetOrderResponse orders_one(id) + +Get Order + +Get Order + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import pos_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.get_order_response import GetOrderResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = pos_api.PosApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # Get Order + api_response = api_instance.orders_one(id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling PosApi->orders_one: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get Order + api_response = api_instance.orders_one(id, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling PosApi->orders_one: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + +### Return type + +[**GetOrderResponse**](GetOrderResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Orders | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **orders_pay** +> CreateOrderResponse orders_pay(id, order) + +Pay Order + +Pay Order + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import pos_api +from apideck.model.create_order_response import CreateOrderResponse +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.order import Order +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = pos_api.PosApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + order = Order( + idempotency_key=IdempotencyKey("random_string"), + order_number="1F", + order_date=dateutil_parser('Fri Aug 12 02:00:00 CEST 2022').date(), + closed_date=dateutil_parser('Sat Aug 13 02:00:00 CEST 2022').date(), + reference_id="my-order-001", + status="open", + payment_status="open", + currency=Currency("USD"), + title="title_example", + note="note_example", + merchant_id="12345", + customer_id="12345", + employee_id="12345", + location_id="12345", + order_type_id="12345", + table="1F", + seat="23F", + total_amount=275, + total_tip=700, + total_tax=275, + total_discount=300, + total_refund=0, + total_service_charge=0, + refunded=False, + customers=[ + OrderCustomers( + first_name="Elon", + middle_name="D.", + last_name="Musk", + phone_numbers=[ + PhoneNumber( + id="12345", + country_code="1", + area_code="323", + number="111-111-1111", + extension="105", + type="primary", + ), + ], + emails=[ + Email( + id="123", + email="elon@musk.com", + type="primary", + ), + ], + ), + ], + fulfillments=[ + OrderFulfillments( + id="12345", + status="proposed", + type="shipment", + pickup_details=OrderPickupDetails( + auto_complete_duration="P1W3D", + cancel_reason="Not hungry", + expires_at=dateutil_parser('2016-09-04T23:59:33.123Z'), + schedule_type="scheduled", + pickup_at=dateutil_parser('2016-09-04T23:59:33.123Z'), + pickup_window_duration="P1W3D", + prep_time_duration="P1W3D", + note="Pickup in the back.", + placed_at=dateutil_parser('2016-09-04T23:59:33.123Z'), + rejected_at=dateutil_parser('2016-09-04T23:59:33.123Z'), + ready_at=dateutil_parser('2016-09-04T23:59:33.123Z'), + expired_at=dateutil_parser('2016-09-04T23:59:33.123Z'), + picked_up_at=dateutil_parser('2016-09-04T23:59:33.123Z'), + canceled_at=dateutil_parser('2016-09-04T23:59:33.123Z'), + is_curbside_pickup=True, + curbside_pickup_details=OrderPickupDetailsCurbsidePickupDetails( + curbside_details="curbside_details_example", + buyer_arrived_at=dateutil_parser('2016-09-04T23:59:33.123Z'), + ), + recipient=OrderPickupDetailsRecipient( + customer_id="12345", + display_name="Elon Musk", + address=Address( + id="123", + type="primary", + string="25 Spring Street, Blackburn, VIC 3130", + name="HQ US", + line1="Main street", + line2="apt #", + line3="Suite #", + line4="delivery instructions", + street_number="25", + city="San Francisco", + state="CA", + postal_code="94104", + country="US", + latitude="40.759211", + longitude="-73.984638", + county="Santa Clara", + contact_name="Elon Musk", + salutation="Mr", + phone_number="111-111-1111", + fax="122-111-1111", + email="elon@musk.com", + website="https://elonmusk.com", + row_version="1-12345", + ), + phone_number=PhoneNumber( + id="12345", + country_code="1", + area_code="323", + number="111-111-1111", + extension="105", + type="primary", + ), + email=Email( + id="123", + email="elon@musk.com", + type="primary", + ), + ), + ), + shipment_details={}, + ), + ], + line_items=[ + OrderLineItems( + name="New York Strip Steak", + item=None, + total_tax=2000, + total_discount=3000, + total_amount=27500, + quantity=1, + unit_price=27500.5, + applied_taxes=[ + None, + ], + applied_discounts=[ + None, + ], + modifiers=[ + None, + ], + ), + ], + payments=[ + OrderPayments( + amount=27500, + currency=Currency("USD"), + ), + ], + service_charges=ServiceCharges([ + ServiceCharge( + name="Charge for delivery", + amount=27500, + percentage=12.5, + currency=Currency("USD"), + active=True, + type="auto_gratuity", + ), + ]), + refunds=[ + OrderRefunds( + amount=27500, + currency=Currency("USD"), + reason="The reason for the refund being issued.", + status="pending", + ), + ], + taxes=[ + None, + ], + discounts=[ + OrderDiscounts( + name="10% off", + type="percentage", + amount=27500, + currency=Currency("USD"), + scope="order", + ), + ], + tenders=[ + OrderTenders( + name="10% off", + type="cash", + note="An optional note associated with the tender at the time of payment.", + amount=27500, + percentage=10, + currency=Currency("USD"), + total_amount=1, + total_tip=7, + total_processing_fee=0, + total_tax=1, + total_discount=3, + total_refund=0, + total_service_charge=0, + buyer_tendered_cash_amount=27500, + change_back_cash_amount=27500, + card=PaymentCard( + bin="41111", + card_brand="visa", + card_type="credit", + prepaid_type="prepaid", + cardholder_name="John Doe", + customer_id="12345", + merchant_id="12345", + exp_month=1, + exp_year=2022, + fingerprint=" Intended as a POS-assigned identifier, based on the card number, to identify the card across multiple locations within a single application.", + last_4="The last 4 digits of the card number.", + enabled=True, + billing_address=Address( + id="123", + type="primary", + string="25 Spring Street, Blackburn, VIC 3130", + name="HQ US", + line1="Main street", + line2="apt #", + line3="Suite #", + line4="delivery instructions", + street_number="25", + city="San Francisco", + state="CA", + postal_code="94104", + country="US", + latitude="40.759211", + longitude="-73.984638", + county="Santa Clara", + contact_name="Elon Musk", + salutation="Mr", + phone_number="111-111-1111", + fax="122-111-1111", + email="elon@musk.com", + website="https://elonmusk.com", + row_version="1-12345", + ), + reference_id="card-001", + version="230320320320", + ), + card_status="authorized", + card_entry_method="swiped", + ), + ], + voided=False, + version="230320320320", + ) # Order | + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + + # example passing only required values which don't have defaults set + try: + # Pay Order + api_response = api_instance.orders_pay(id, order) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling PosApi->orders_pay: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Pay Order + api_response = api_instance.orders_pay(id, order, raw=raw, consumer_id=consumer_id, app_id=app_id, service_id=service_id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling PosApi->orders_pay: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **order** | [**Order**](Order.md)| | + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + +### Return type + +[**CreateOrderResponse**](CreateOrderResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**201** | Orders | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **orders_update** +> UpdateOrderResponse orders_update(id, order) + +Update Order + +Updates an open order by adding, replacing, or deleting fields. Square-only: Orders with a `completed` or `canceled` status cannot be updated. To pay for an order, use the [payments endpoint](#tag/Payments). + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import pos_api +from apideck.model.update_order_response import UpdateOrderResponse +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.order import Order +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = pos_api.PosApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + order = Order( + idempotency_key=IdempotencyKey("random_string"), + order_number="1F", + order_date=dateutil_parser('Fri Aug 12 02:00:00 CEST 2022').date(), + closed_date=dateutil_parser('Sat Aug 13 02:00:00 CEST 2022').date(), + reference_id="my-order-001", + status="open", + payment_status="open", + currency=Currency("USD"), + title="title_example", + note="note_example", + merchant_id="12345", + customer_id="12345", + employee_id="12345", + location_id="12345", + order_type_id="12345", + table="1F", + seat="23F", + total_amount=275, + total_tip=700, + total_tax=275, + total_discount=300, + total_refund=0, + total_service_charge=0, + refunded=False, + customers=[ + OrderCustomers( + first_name="Elon", + middle_name="D.", + last_name="Musk", + phone_numbers=[ + PhoneNumber( + id="12345", + country_code="1", + area_code="323", + number="111-111-1111", + extension="105", + type="primary", + ), + ], + emails=[ + Email( + id="123", + email="elon@musk.com", + type="primary", + ), + ], + ), + ], + fulfillments=[ + OrderFulfillments( + id="12345", + status="proposed", + type="shipment", + pickup_details=OrderPickupDetails( + auto_complete_duration="P1W3D", + cancel_reason="Not hungry", + expires_at=dateutil_parser('2016-09-04T23:59:33.123Z'), + schedule_type="scheduled", + pickup_at=dateutil_parser('2016-09-04T23:59:33.123Z'), + pickup_window_duration="P1W3D", + prep_time_duration="P1W3D", + note="Pickup in the back.", + placed_at=dateutil_parser('2016-09-04T23:59:33.123Z'), + rejected_at=dateutil_parser('2016-09-04T23:59:33.123Z'), + ready_at=dateutil_parser('2016-09-04T23:59:33.123Z'), + expired_at=dateutil_parser('2016-09-04T23:59:33.123Z'), + picked_up_at=dateutil_parser('2016-09-04T23:59:33.123Z'), + canceled_at=dateutil_parser('2016-09-04T23:59:33.123Z'), + is_curbside_pickup=True, + curbside_pickup_details=OrderPickupDetailsCurbsidePickupDetails( + curbside_details="curbside_details_example", + buyer_arrived_at=dateutil_parser('2016-09-04T23:59:33.123Z'), + ), + recipient=OrderPickupDetailsRecipient( + customer_id="12345", + display_name="Elon Musk", + address=Address( + id="123", + type="primary", + string="25 Spring Street, Blackburn, VIC 3130", + name="HQ US", + line1="Main street", + line2="apt #", + line3="Suite #", + line4="delivery instructions", + street_number="25", + city="San Francisco", + state="CA", + postal_code="94104", + country="US", + latitude="40.759211", + longitude="-73.984638", + county="Santa Clara", + contact_name="Elon Musk", + salutation="Mr", + phone_number="111-111-1111", + fax="122-111-1111", + email="elon@musk.com", + website="https://elonmusk.com", + row_version="1-12345", + ), + phone_number=PhoneNumber( + id="12345", + country_code="1", + area_code="323", + number="111-111-1111", + extension="105", + type="primary", + ), + email=Email( + id="123", + email="elon@musk.com", + type="primary", + ), + ), + ), + shipment_details={}, + ), + ], + line_items=[ + OrderLineItems( + name="New York Strip Steak", + item=None, + total_tax=2000, + total_discount=3000, + total_amount=27500, + quantity=1, + unit_price=27500.5, + applied_taxes=[ + None, + ], + applied_discounts=[ + None, + ], + modifiers=[ + None, + ], + ), + ], + payments=[ + OrderPayments( + amount=27500, + currency=Currency("USD"), + ), + ], + service_charges=ServiceCharges([ + ServiceCharge( + name="Charge for delivery", + amount=27500, + percentage=12.5, + currency=Currency("USD"), + active=True, + type="auto_gratuity", + ), + ]), + refunds=[ + OrderRefunds( + amount=27500, + currency=Currency("USD"), + reason="The reason for the refund being issued.", + status="pending", + ), + ], + taxes=[ + None, + ], + discounts=[ + OrderDiscounts( + name="10% off", + type="percentage", + amount=27500, + currency=Currency("USD"), + scope="order", + ), + ], + tenders=[ + OrderTenders( + name="10% off", + type="cash", + note="An optional note associated with the tender at the time of payment.", + amount=27500, + percentage=10, + currency=Currency("USD"), + total_amount=1, + total_tip=7, + total_processing_fee=0, + total_tax=1, + total_discount=3, + total_refund=0, + total_service_charge=0, + buyer_tendered_cash_amount=27500, + change_back_cash_amount=27500, + card=PaymentCard( + bin="41111", + card_brand="visa", + card_type="credit", + prepaid_type="prepaid", + cardholder_name="John Doe", + customer_id="12345", + merchant_id="12345", + exp_month=1, + exp_year=2022, + fingerprint=" Intended as a POS-assigned identifier, based on the card number, to identify the card across multiple locations within a single application.", + last_4="The last 4 digits of the card number.", + enabled=True, + billing_address=Address( + id="123", + type="primary", + string="25 Spring Street, Blackburn, VIC 3130", + name="HQ US", + line1="Main street", + line2="apt #", + line3="Suite #", + line4="delivery instructions", + street_number="25", + city="San Francisco", + state="CA", + postal_code="94104", + country="US", + latitude="40.759211", + longitude="-73.984638", + county="Santa Clara", + contact_name="Elon Musk", + salutation="Mr", + phone_number="111-111-1111", + fax="122-111-1111", + email="elon@musk.com", + website="https://elonmusk.com", + row_version="1-12345", + ), + reference_id="card-001", + version="230320320320", + ), + card_status="authorized", + card_entry_method="swiped", + ), + ], + voided=False, + version="230320320320", + ) # Order | + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # Update Order + api_response = api_instance.orders_update(id, order) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling PosApi->orders_update: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Update Order + api_response = api_instance.orders_update(id, order, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling PosApi->orders_update: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **order** | [**Order**](Order.md)| | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + +### Return type + +[**UpdateOrderResponse**](UpdateOrderResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Orders | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **payments_add** +> CreatePosPaymentResponse payments_add(pos_payment) + +Create Payment + +Create Payment + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import pos_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.pos_payment import PosPayment +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.create_pos_payment_response import CreatePosPaymentResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = pos_api.PosApi(api_client) + pos_payment = PosPayment( + source_id="12345", + order_id="12345", + merchant_id="12345", + customer_id="12345", + employee_id="12345", + location_id="12345", + device_id="12345", + tender_id="12345", + external_payment_id="12345", + idempotency_key=IdempotencyKey("random_string"), + amount=27.5, + currency=Currency("USD"), + tip=7, + tax=20, + total=37.5, + app_fee=3, + change_back_cash_amount=20, + approved=37.5, + refunded=37.5, + processing_fees=[{"amount":1.05,"effective_at":"2020-09-30T07:43:32.000Z","processing_type":"initial"}], + source="external", + status="approved", + cash=CashDetails( + amount=None, + charge_back_amount=None, + ), + card_details=PosPaymentCardDetails( + card=PaymentCard( + bin="41111", + card_brand="visa", + card_type="credit", + prepaid_type="prepaid", + cardholder_name="John Doe", + customer_id="12345", + merchant_id="12345", + exp_month=1, + exp_year=2022, + fingerprint=" Intended as a POS-assigned identifier, based on the card number, to identify the card across multiple locations within a single application.", + last_4="The last 4 digits of the card number.", + enabled=True, + billing_address=Address( + id="123", + type="primary", + string="25 Spring Street, Blackburn, VIC 3130", + name="HQ US", + line1="Main street", + line2="apt #", + line3="Suite #", + line4="delivery instructions", + street_number="25", + city="San Francisco", + state="CA", + postal_code="94104", + country="US", + latitude="40.759211", + longitude="-73.984638", + county="Santa Clara", + contact_name="Elon Musk", + salutation="Mr", + phone_number="111-111-1111", + fax="122-111-1111", + email="elon@musk.com", + website="https://elonmusk.com", + row_version="1-12345", + ), + reference_id="card-001", + version="230320320320", + ), + ), + bank_account=PosBankAccount( + bank_name="bank_name_example", + transfer_type="transfer_type_example", + account_ownership_type="account_ownership_type_example", + fingerprint="fingerprint_example", + country="US", + statement_description="statement_description_example", + ach_details=PosBankAccountAchDetails( + routing_number="routing_number_example", + account_number_suffix="account_number_suffix_example", + account_type="account_type_example", + ), + ), + wallet=WalletDetails( + status="authorized", + ), + external_details=PosPaymentExternalDetails( + type="check", + source="source_example", + source_id="source_id_example", + source_fee_amount=2.5, + ), + service_charges=ServiceCharges([ + ServiceCharge( + name="Charge for delivery", + amount=27500, + percentage=12.5, + currency=Currency("USD"), + active=True, + type="auto_gratuity", + ), + ]), + ) # PosPayment | + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + + # example passing only required values which don't have defaults set + try: + # Create Payment + api_response = api_instance.payments_add(pos_payment) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling PosApi->payments_add: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Create Payment + api_response = api_instance.payments_add(pos_payment, raw=raw, consumer_id=consumer_id, app_id=app_id, service_id=service_id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling PosApi->payments_add: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pos_payment** | [**PosPayment**](PosPayment.md)| | + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + +### Return type + +[**CreatePosPaymentResponse**](CreatePosPaymentResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**201** | PosPayments | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **payments_all** +> GetPosPaymentsResponse payments_all() + +List Payments + +List Payments + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import pos_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.get_pos_payments_response import GetPosPaymentsResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = pos_api.PosApi(api_client) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + cursor = "cursor_example" # str, none_type | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. (optional) + limit = 20 # int | Number of records to return (optional) if omitted the server will use the default value of 20 + + # example passing only required values which don't have defaults set + # and optional values + try: + # List Payments + api_response = api_instance.payments_all(raw=raw, consumer_id=consumer_id, app_id=app_id, service_id=service_id, cursor=cursor, limit=limit) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling PosApi->payments_all: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **cursor** | **str, none_type**| Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | [optional] + **limit** | **int**| Number of records to return | [optional] if omitted the server will use the default value of 20 + +### Return type + +[**GetPosPaymentsResponse**](GetPosPaymentsResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | PosPayments | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **payments_delete** +> DeletePosPaymentResponse payments_delete(id) + +Delete Payment + +Delete Payment + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import pos_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.delete_pos_payment_response import DeletePosPaymentResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = pos_api.PosApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # Delete Payment + api_response = api_instance.payments_delete(id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling PosApi->payments_delete: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Delete Payment + api_response = api_instance.payments_delete(id, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling PosApi->payments_delete: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + +### Return type + +[**DeletePosPaymentResponse**](DeletePosPaymentResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | PosPayments | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **payments_one** +> GetPosPaymentResponse payments_one(id) + +Get Payment + +Get Payment + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import pos_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.get_pos_payment_response import GetPosPaymentResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = pos_api.PosApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # Get Payment + api_response = api_instance.payments_one(id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling PosApi->payments_one: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get Payment + api_response = api_instance.payments_one(id, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling PosApi->payments_one: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + +### Return type + +[**GetPosPaymentResponse**](GetPosPaymentResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | PosPayments | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **payments_update** +> UpdatePosPaymentResponse payments_update(id, pos_payment) + +Update Payment + +Update Payment + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import pos_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.update_pos_payment_response import UpdatePosPaymentResponse +from apideck.model.pos_payment import PosPayment +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = pos_api.PosApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + pos_payment = PosPayment( + source_id="12345", + order_id="12345", + merchant_id="12345", + customer_id="12345", + employee_id="12345", + location_id="12345", + device_id="12345", + tender_id="12345", + external_payment_id="12345", + idempotency_key=IdempotencyKey("random_string"), + amount=27.5, + currency=Currency("USD"), + tip=7, + tax=20, + total=37.5, + app_fee=3, + change_back_cash_amount=20, + approved=37.5, + refunded=37.5, + processing_fees=[{"amount":1.05,"effective_at":"2020-09-30T07:43:32.000Z","processing_type":"initial"}], + source="external", + status="approved", + cash=CashDetails( + amount=None, + charge_back_amount=None, + ), + card_details=PosPaymentCardDetails( + card=PaymentCard( + bin="41111", + card_brand="visa", + card_type="credit", + prepaid_type="prepaid", + cardholder_name="John Doe", + customer_id="12345", + merchant_id="12345", + exp_month=1, + exp_year=2022, + fingerprint=" Intended as a POS-assigned identifier, based on the card number, to identify the card across multiple locations within a single application.", + last_4="The last 4 digits of the card number.", + enabled=True, + billing_address=Address( + id="123", + type="primary", + string="25 Spring Street, Blackburn, VIC 3130", + name="HQ US", + line1="Main street", + line2="apt #", + line3="Suite #", + line4="delivery instructions", + street_number="25", + city="San Francisco", + state="CA", + postal_code="94104", + country="US", + latitude="40.759211", + longitude="-73.984638", + county="Santa Clara", + contact_name="Elon Musk", + salutation="Mr", + phone_number="111-111-1111", + fax="122-111-1111", + email="elon@musk.com", + website="https://elonmusk.com", + row_version="1-12345", + ), + reference_id="card-001", + version="230320320320", + ), + ), + bank_account=PosBankAccount( + bank_name="bank_name_example", + transfer_type="transfer_type_example", + account_ownership_type="account_ownership_type_example", + fingerprint="fingerprint_example", + country="US", + statement_description="statement_description_example", + ach_details=PosBankAccountAchDetails( + routing_number="routing_number_example", + account_number_suffix="account_number_suffix_example", + account_type="account_type_example", + ), + ), + wallet=WalletDetails( + status="authorized", + ), + external_details=PosPaymentExternalDetails( + type="check", + source="source_example", + source_id="source_id_example", + source_fee_amount=2.5, + ), + service_charges=ServiceCharges([ + ServiceCharge( + name="Charge for delivery", + amount=27500, + percentage=12.5, + currency=Currency("USD"), + active=True, + type="auto_gratuity", + ), + ]), + ) # PosPayment | + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # Update Payment + api_response = api_instance.payments_update(id, pos_payment) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling PosApi->payments_update: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Update Payment + api_response = api_instance.payments_update(id, pos_payment, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling PosApi->payments_update: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **pos_payment** | [**PosPayment**](PosPayment.md)| | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + +### Return type + +[**UpdatePosPaymentResponse**](UpdatePosPaymentResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | PosPayments | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **tenders_add** +> CreateTenderResponse tenders_add(tender) + +Create Tender + +Create Tender + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import pos_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.create_tender_response import CreateTenderResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.tender import Tender +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = pos_api.PosApi(api_client) + tender = Tender( + key="com.clover.tender.cash", + label="Cash", + active=True, + hidden=True, + editable=True, + opens_cash_drawer=True, + allows_tipping=True, + ) # Tender | + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + + # example passing only required values which don't have defaults set + try: + # Create Tender + api_response = api_instance.tenders_add(tender) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling PosApi->tenders_add: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Create Tender + api_response = api_instance.tenders_add(tender, raw=raw, consumer_id=consumer_id, app_id=app_id, service_id=service_id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling PosApi->tenders_add: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **tender** | [**Tender**](Tender.md)| | + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + +### Return type + +[**CreateTenderResponse**](CreateTenderResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**201** | Tenders | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **tenders_all** +> GetTendersResponse tenders_all() + +List Tenders + +List Tenders + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import pos_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.get_tenders_response import GetTendersResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = pos_api.PosApi(api_client) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + cursor = "cursor_example" # str, none_type | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. (optional) + limit = 20 # int | Number of records to return (optional) if omitted the server will use the default value of 20 + + # example passing only required values which don't have defaults set + # and optional values + try: + # List Tenders + api_response = api_instance.tenders_all(raw=raw, consumer_id=consumer_id, app_id=app_id, service_id=service_id, cursor=cursor, limit=limit) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling PosApi->tenders_all: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **cursor** | **str, none_type**| Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | [optional] + **limit** | **int**| Number of records to return | [optional] if omitted the server will use the default value of 20 + +### Return type + +[**GetTendersResponse**](GetTendersResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Tenders | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **tenders_delete** +> DeleteTenderResponse tenders_delete(id) + +Delete Tender + +Delete Tender + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import pos_api +from apideck.model.delete_tender_response import DeleteTenderResponse +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = pos_api.PosApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # Delete Tender + api_response = api_instance.tenders_delete(id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling PosApi->tenders_delete: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Delete Tender + api_response = api_instance.tenders_delete(id, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling PosApi->tenders_delete: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + +### Return type + +[**DeleteTenderResponse**](DeleteTenderResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Tenders | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **tenders_one** +> GetTenderResponse tenders_one(id) + +Get Tender + +Get Tender + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import pos_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.get_tender_response import GetTenderResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = pos_api.PosApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # Get Tender + api_response = api_instance.tenders_one(id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling PosApi->tenders_one: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get Tender + api_response = api_instance.tenders_one(id, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling PosApi->tenders_one: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + +### Return type + +[**GetTenderResponse**](GetTenderResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Tenders | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **tenders_update** +> UpdateTenderResponse tenders_update(id, tender) + +Update Tender + +Update Tender + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import pos_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.update_tender_response import UpdateTenderResponse +from apideck.model.tender import Tender +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = pos_api.PosApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + tender = Tender( + key="com.clover.tender.cash", + label="Cash", + active=True, + hidden=True, + editable=True, + opens_cash_drawer=True, + allows_tipping=True, + ) # Tender | + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # Update Tender + api_response = api_instance.tenders_update(id, tender) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling PosApi->tenders_update: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Update Tender + api_response = api_instance.tenders_update(id, tender, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling PosApi->tenders_update: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **tender** | [**Tender**](Tender.md)| | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + +### Return type + +[**UpdateTenderResponse**](UpdateTenderResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Tenders | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + diff --git a/docs/apis/SmsApi.md b/docs/apis/SmsApi.md new file mode 100644 index 0000000000..df0b88c459 --- /dev/null +++ b/docs/apis/SmsApi.md @@ -0,0 +1,566 @@ +# apideck.SmsApi + +All URIs are relative to *https://unify.apideck.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**messages_add**](SmsApi.md#messages_add) | **POST** /sms/messages | Create Message +[**messages_all**](SmsApi.md#messages_all) | **GET** /sms/messages | List Messages +[**messages_delete**](SmsApi.md#messages_delete) | **DELETE** /sms/messages/{id} | Delete Message +[**messages_one**](SmsApi.md#messages_one) | **GET** /sms/messages/{id} | Get Message +[**messages_update**](SmsApi.md#messages_update) | **PATCH** /sms/messages/{id} | Update Message + + +# **messages_add** +> CreateMessageResponse messages_add(message) + +Create Message + +Create Message + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import sms_api +from apideck.model.create_message_response import CreateMessageResponse +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.message import Message +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = sms_api.SmsApi(api_client) + message = Message( + _from="+15017122661", + to="+15017122662", + subject="Picture", + body="Hi! How are you doing?", + type="sms", + scheduled_at=dateutil_parser('2020-09-30T07:43:32Z'), + webhook_url="https://unify.apideck.com/webhook/webhooks/eyz329dkffdl4949/x/sms", + reference="CUST001", + messaging_service_id="123456", + ) # Message | + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + + # example passing only required values which don't have defaults set + try: + # Create Message + api_response = api_instance.messages_add(message) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling SmsApi->messages_add: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Create Message + api_response = api_instance.messages_add(message, raw=raw, consumer_id=consumer_id, app_id=app_id, service_id=service_id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling SmsApi->messages_add: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **message** | [**Message**](Message.md)| | + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + +### Return type + +[**CreateMessageResponse**](CreateMessageResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**201** | Messages | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **messages_all** +> GetMessagesResponse messages_all() + +List Messages + +List Messages + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import sms_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.get_messages_response import GetMessagesResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = sms_api.SmsApi(api_client) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + cursor = "cursor_example" # str, none_type | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. (optional) + limit = 20 # int | Number of records to return (optional) if omitted the server will use the default value of 20 + + # example passing only required values which don't have defaults set + # and optional values + try: + # List Messages + api_response = api_instance.messages_all(raw=raw, consumer_id=consumer_id, app_id=app_id, service_id=service_id, cursor=cursor, limit=limit) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling SmsApi->messages_all: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **cursor** | **str, none_type**| Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | [optional] + **limit** | **int**| Number of records to return | [optional] if omitted the server will use the default value of 20 + +### Return type + +[**GetMessagesResponse**](GetMessagesResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Messages | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **messages_delete** +> DeleteMessageResponse messages_delete(id) + +Delete Message + +Delete Message + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import sms_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.delete_message_response import DeleteMessageResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = sms_api.SmsApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # Delete Message + api_response = api_instance.messages_delete(id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling SmsApi->messages_delete: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Delete Message + api_response = api_instance.messages_delete(id, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling SmsApi->messages_delete: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + +### Return type + +[**DeleteMessageResponse**](DeleteMessageResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Messages | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **messages_one** +> GetMessageResponse messages_one(id) + +Get Message + +Get Message + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import sms_api +from apideck.model.get_message_response import GetMessageResponse +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = sms_api.SmsApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # Get Message + api_response = api_instance.messages_one(id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling SmsApi->messages_one: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get Message + api_response = api_instance.messages_one(id, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling SmsApi->messages_one: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + +### Return type + +[**GetMessageResponse**](GetMessageResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Messages | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **messages_update** +> UpdateMessageResponse messages_update(id, message) + +Update Message + +Update Message + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import sms_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.message import Message +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.update_message_response import UpdateMessageResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = sms_api.SmsApi(api_client) + id = "id_example" # str | ID of the record you are acting upon. + message = Message( + _from="+15017122661", + to="+15017122662", + subject="Picture", + body="Hi! How are you doing?", + type="sms", + scheduled_at=dateutil_parser('2020-09-30T07:43:32Z'), + webhook_url="https://unify.apideck.com/webhook/webhooks/eyz329dkffdl4949/x/sms", + reference="CUST001", + messaging_service_id="123456", + ) # Message | + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional) + raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # Update Message + api_response = api_instance.messages_update(id, message) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling SmsApi->messages_update: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Update Message + api_response = api_instance.messages_update(id, message, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling SmsApi->messages_update: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| ID of the record you are acting upon. | + **message** | [**Message**](Message.md)| | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional] + **raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False + +### Return type + +[**UpdateMessageResponse**](UpdateMessageResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Messages | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + diff --git a/docs/apis/VaultApi.md b/docs/apis/VaultApi.md new file mode 100644 index 0000000000..9c13ca12f2 --- /dev/null +++ b/docs/apis/VaultApi.md @@ -0,0 +1,1334 @@ +# apideck.VaultApi + +All URIs are relative to *https://unify.apideck.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**connection_settings_all**](VaultApi.md#connection_settings_all) | **GET** /vault/connections/{unified_api}/{service_id}/{resource}/config | Get resource settings +[**connection_settings_update**](VaultApi.md#connection_settings_update) | **PATCH** /vault/connections/{unified_api}/{service_id}/{resource}/config | Update settings +[**connections_all**](VaultApi.md#connections_all) | **GET** /vault/connections | Get all connections +[**connections_delete**](VaultApi.md#connections_delete) | **DELETE** /vault/connections/{unified_api}/{service_id} | Deletes a connection +[**connections_import**](VaultApi.md#connections_import) | **POST** /vault/connections/{unified_api}/{service_id}/import | Import connection +[**connections_one**](VaultApi.md#connections_one) | **GET** /vault/connections/{unified_api}/{service_id} | Get connection +[**connections_update**](VaultApi.md#connections_update) | **PATCH** /vault/connections/{unified_api}/{service_id} | Update connection +[**consumer_request_counts_all**](VaultApi.md#consumer_request_counts_all) | **GET** /vault/consumers/{consumer_id}/stats | Consumer request counts +[**consumers_all**](VaultApi.md#consumers_all) | **GET** /vault/consumers | Get all consumers +[**consumers_one**](VaultApi.md#consumers_one) | **GET** /vault/consumers/{consumer_id} | Get consumer +[**logs_all**](VaultApi.md#logs_all) | **GET** /vault/logs | Get all consumer request logs +[**sessions_create**](VaultApi.md#sessions_create) | **POST** /vault/sessions | Create Session + + +# **connection_settings_all** +> GetConnectionResponse connection_settings_all(unified_api, service_id, resource) + +Get resource settings + +This endpoint returns custom settings and their defaults required by connection for a given resource. + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import vault_api +from apideck.model.get_connection_response import GetConnectionResponse +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = vault_api.VaultApi(api_client) + unified_api = "crm" # str | Unified API + service_id = "pipedrive" # str | Service ID of the resource to return + resource = "leads" # str | Resource Name + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + + # example passing only required values which don't have defaults set + try: + # Get resource settings + api_response = api_instance.connection_settings_all(unified_api, service_id, resource) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling VaultApi->connection_settings_all: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get resource settings + api_response = api_instance.connection_settings_all(unified_api, service_id, resource, consumer_id=consumer_id, app_id=app_id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling VaultApi->connection_settings_all: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **unified_api** | **str**| Unified API | + **service_id** | **str**| Service ID of the resource to return | + **resource** | **str**| Resource Name | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + +### Return type + +[**GetConnectionResponse**](GetConnectionResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Connection | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **connection_settings_update** +> UpdateConnectionResponse connection_settings_update(service_id, unified_api, resource, connection) + +Update settings + +Update default values for a connection's resource settings + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import vault_api +from apideck.model.connection import Connection +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.update_connection_response import UpdateConnectionResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = vault_api.VaultApi(api_client) + service_id = "pipedrive" # str | Service ID of the resource to return + unified_api = "crm" # str | Unified API + resource = "leads" # str | Resource Name + connection = Connection( + enabled=True, + settings={}, + metadata={}, + configuration=[ + ConnectionConfiguration( + resource="leads", + defaults=[ + ConnectionDefaults( + id="ProductInterest", + options=[ + FormFieldOption(None), + ], + value=None, + ), + ], + ), + ], + ) # Connection | Fields that need to be updated on the resource + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + + # example passing only required values which don't have defaults set + try: + # Update settings + api_response = api_instance.connection_settings_update(service_id, unified_api, resource, connection) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling VaultApi->connection_settings_update: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Update settings + api_response = api_instance.connection_settings_update(service_id, unified_api, resource, connection, consumer_id=consumer_id, app_id=app_id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling VaultApi->connection_settings_update: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **service_id** | **str**| Service ID of the resource to return | + **unified_api** | **str**| Unified API | + **resource** | **str**| Resource Name | + **connection** | [**Connection**](Connection.md)| Fields that need to be updated on the resource | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + +### Return type + +[**UpdateConnectionResponse**](UpdateConnectionResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Connection updated | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **connections_all** +> GetConnectionsResponse connections_all() + +Get all connections + +This endpoint includes all the configured integrations and contains the required assets to build an integrations page where your users can install integrations. OAuth2 supported integrations will contain authorize and revoke links to handle the authentication flows. + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import vault_api +from apideck.model.get_connections_response import GetConnectionsResponse +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = vault_api.VaultApi(api_client) + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + api = "crm" # str | Scope results to Unified API (optional) + configured = True # bool | Scopes results to connections that have been configured or not (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get all connections + api_response = api_instance.connections_all(consumer_id=consumer_id, app_id=app_id, api=api, configured=configured) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling VaultApi->connections_all: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **api** | **str**| Scope results to Unified API | [optional] + **configured** | **bool**| Scopes results to connections that have been configured or not | [optional] + +### Return type + +[**GetConnectionsResponse**](GetConnectionsResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Connections | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **connections_delete** +> connections_delete(service_id, unified_api) + +Deletes a connection + +Deletes a connection + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import vault_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = vault_api.VaultApi(api_client) + service_id = "pipedrive" # str | Service ID of the resource to return + unified_api = "crm" # str | Unified API + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + + # example passing only required values which don't have defaults set + try: + # Deletes a connection + api_instance.connections_delete(service_id, unified_api) + except apideck.ApiException as e: + print("Exception when calling VaultApi->connections_delete: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Deletes a connection + api_instance.connections_delete(service_id, unified_api, consumer_id=consumer_id, app_id=app_id) + except apideck.ApiException as e: + print("Exception when calling VaultApi->connections_delete: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **service_id** | **str**| Service ID of the resource to return | + **unified_api** | **str**| Unified API | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + +### Return type + +void (empty response body) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**204** | Resource deleted | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **connections_import** +> CreateConnectionResponse connections_import(service_id, unified_api, connection_import_data) + +Import connection + +Import an authorized connection. + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import vault_api +from apideck.model.connection_import_data import ConnectionImportData +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.create_connection_response import CreateConnectionResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = vault_api.VaultApi(api_client) + service_id = "pipedrive" # str | Service ID of the resource to return + unified_api = "crm" # str | Unified API + connection_import_data = ConnectionImportData( + credentials=ConnectionImportDataCredentials( + refresh_token="1234567890abcdefghijklmnopqrstuvwxyz", + access_token="1234567890abcdefghijklmnopqrstuvwxyz", + issued_at=dateutil_parser('2020-01-01T00:00:00Z'), + expires_in=3600, + ), + settings={}, + metadata={}, + ) # ConnectionImportData | Fields that need to be persisted on the resource + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + + # example passing only required values which don't have defaults set + try: + # Import connection + api_response = api_instance.connections_import(service_id, unified_api, connection_import_data) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling VaultApi->connections_import: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Import connection + api_response = api_instance.connections_import(service_id, unified_api, connection_import_data, consumer_id=consumer_id, app_id=app_id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling VaultApi->connections_import: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **service_id** | **str**| Service ID of the resource to return | + **unified_api** | **str**| Unified API | + **connection_import_data** | [**ConnectionImportData**](ConnectionImportData.md)| Fields that need to be persisted on the resource | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + +### Return type + +[**CreateConnectionResponse**](CreateConnectionResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Connection created | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **connections_one** +> GetConnectionResponse connections_one(service_id, unified_api) + +Get connection + +Get a connection + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import vault_api +from apideck.model.get_connection_response import GetConnectionResponse +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = vault_api.VaultApi(api_client) + service_id = "pipedrive" # str | Service ID of the resource to return + unified_api = "crm" # str | Unified API + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + + # example passing only required values which don't have defaults set + try: + # Get connection + api_response = api_instance.connections_one(service_id, unified_api) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling VaultApi->connections_one: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get connection + api_response = api_instance.connections_one(service_id, unified_api, consumer_id=consumer_id, app_id=app_id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling VaultApi->connections_one: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **service_id** | **str**| Service ID of the resource to return | + **unified_api** | **str**| Unified API | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + +### Return type + +[**GetConnectionResponse**](GetConnectionResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Connection | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **connections_update** +> UpdateConnectionResponse connections_update(service_id, unified_api, connection) + +Update connection + +Update a connection + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import vault_api +from apideck.model.connection import Connection +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.update_connection_response import UpdateConnectionResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = vault_api.VaultApi(api_client) + service_id = "pipedrive" # str | Service ID of the resource to return + unified_api = "crm" # str | Unified API + connection = Connection( + enabled=True, + settings={}, + metadata={}, + configuration=[ + ConnectionConfiguration( + resource="leads", + defaults=[ + ConnectionDefaults( + id="ProductInterest", + options=[ + FormFieldOption(None), + ], + value=None, + ), + ], + ), + ], + ) # Connection | Fields that need to be updated on the resource + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + + # example passing only required values which don't have defaults set + try: + # Update connection + api_response = api_instance.connections_update(service_id, unified_api, connection) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling VaultApi->connections_update: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Update connection + api_response = api_instance.connections_update(service_id, unified_api, connection, consumer_id=consumer_id, app_id=app_id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling VaultApi->connections_update: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **service_id** | **str**| Service ID of the resource to return | + **unified_api** | **str**| Unified API | + **connection** | [**Connection**](Connection.md)| Fields that need to be updated on the resource | + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + +### Return type + +[**UpdateConnectionResponse**](UpdateConnectionResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Connection updated | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **consumer_request_counts_all** +> ConsumerRequestCountsInDateRangeResponse consumer_request_counts_all(consumer_id, start_datetime, end_datetime) + +Consumer request counts + +Get consumer request counts within a given datetime range. + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import vault_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.consumer_request_counts_in_date_range_response import ConsumerRequestCountsInDateRangeResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = vault_api.VaultApi(api_client) + consumer_id = "test_user_id" # str | ID of the consumer to return + start_datetime = "2021-05-01T12:00:00.000Z" # str | Scopes results to requests that happened after datetime + end_datetime = "2021-05-30T12:00:00.000Z" # str | Scopes results to requests that happened before datetime + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + + # example passing only required values which don't have defaults set + try: + # Consumer request counts + api_response = api_instance.consumer_request_counts_all(consumer_id, start_datetime, end_datetime) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling VaultApi->consumer_request_counts_all: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Consumer request counts + api_response = api_instance.consumer_request_counts_all(consumer_id, start_datetime, end_datetime, app_id=app_id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling VaultApi->consumer_request_counts_all: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **consumer_id** | **str**| ID of the consumer to return | + **start_datetime** | **str**| Scopes results to requests that happened after datetime | + **end_datetime** | **str**| Scopes results to requests that happened before datetime | + **app_id** | **str**| The ID of your Unify application | [optional] + +### Return type + +[**ConsumerRequestCountsInDateRangeResponse**](ConsumerRequestCountsInDateRangeResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Consumers Request Counts within Date Range | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **consumers_all** +> GetConsumersResponse consumers_all() + +Get all consumers + +This endpoint includes all application consumers, along with an aggregated count of requests made. + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import vault_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.get_consumers_response import GetConsumersResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = vault_api.VaultApi(api_client) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + cursor = "cursor_example" # str, none_type | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. (optional) + limit = 20 # int | Number of records to return (optional) if omitted the server will use the default value of 20 + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get all consumers + api_response = api_instance.consumers_all(app_id=app_id, cursor=cursor, limit=limit) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling VaultApi->consumers_all: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **app_id** | **str**| The ID of your Unify application | [optional] + **cursor** | **str, none_type**| Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | [optional] + **limit** | **int**| Number of records to return | [optional] if omitted the server will use the default value of 20 + +### Return type + +[**GetConsumersResponse**](GetConsumersResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Consumers | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **consumers_one** +> GetConsumerResponse consumers_one(consumer_id) + +Get consumer + +Consumer detail including their aggregated counts with the connections they have authorized. + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import vault_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.get_consumer_response import GetConsumerResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = vault_api.VaultApi(api_client) + consumer_id = "test_user_id" # str | ID of the consumer to return + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + + # example passing only required values which don't have defaults set + try: + # Get consumer + api_response = api_instance.consumers_one(consumer_id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling VaultApi->consumers_one: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get consumer + api_response = api_instance.consumers_one(consumer_id, app_id=app_id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling VaultApi->consumers_one: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **consumer_id** | **str**| ID of the consumer to return | + **app_id** | **str**| The ID of your Unify application | [optional] + +### Return type + +[**GetConsumerResponse**](GetConsumerResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Consumer | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **logs_all** +> GetLogsResponse logs_all() + +Get all consumer request logs + +This endpoint includes all consumer request logs. + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import vault_api +from apideck.model.logs_filter import LogsFilter +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.get_logs_response import GetLogsResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = vault_api.VaultApi(api_client) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + filter = LogsFilter( + connector_id="crm+salesforce", + status_code=201, + exclude_unified_apis="vault,proxy", + ) # LogsFilter | Filter results (optional) + cursor = "cursor_example" # str, none_type | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. (optional) + limit = 20 # int | Number of records to return (optional) if omitted the server will use the default value of 20 + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get all consumer request logs + api_response = api_instance.logs_all(app_id=app_id, consumer_id=consumer_id, filter=filter, cursor=cursor, limit=limit) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling VaultApi->logs_all: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **app_id** | **str**| The ID of your Unify application | [optional] + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **filter** | **LogsFilter**| Filter results | [optional] + **cursor** | **str, none_type**| Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | [optional] + **limit** | **int**| Number of records to return | [optional] if omitted the server will use the default value of 20 + +### Return type + +[**GetLogsResponse**](GetLogsResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Logs | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **sessions_create** +> CreateSessionResponse sessions_create() + +Create Session + +Making a POST request to this endpoint will initiate a Hosted Vault session. Redirect the consumer to the returned url to allow temporary access to manage their integrations and settings. Note: This is a short lived token that will expire after 1 hour (TTL: 3600). + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import vault_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.create_session_response import CreateSessionResponse +from apideck.model.session import Session +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = vault_api.VaultApi(api_client) + consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + session = Session( + consumer_metadata=ConsumerMetadata( + account_name="SpaceX", + user_name="Elon Musk", + email="elon@musk.com", + image="https://www.spacex.com/static/images/share.jpg", + ), + custom_consumer_settings={}, + redirect_uri="https://mysaas.com/dashboard", + settings=SessionSettings( + unified_apis=[ + UnifiedApiId("crm"), + ], + hide_resource_settings=False, + sandbox_mode=False, + isolation_mode=False, + session_length="30m", + show_logs=True, + show_suggestions=False, + show_sidebar=True, + auto_redirect=False, + ), + theme=SessionTheme( + favicon="https://res.cloudinary.com/apideck/icons/intercom", + primary_color="#286efa", + privacy_url="https://compliance.apideck.com/privacy-policy", + sidepanel_background_color="#286efa", + sidepanel_text_color="#FFFFFF", + terms_url="https://www.termsfeed.com/terms-conditions/957c85c1b089ae9e3219c83eff65377e", + vault_name="Intercom", + ), + ) # Session | Additional redirect uri and/or consumer metadata (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Create Session + api_response = api_instance.sessions_create(consumer_id=consumer_id, app_id=app_id, session=session) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling VaultApi->sessions_create: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional] + **app_id** | **str**| The ID of your Unify application | [optional] + **session** | [**Session**](Session.md)| Additional redirect uri and/or consumer metadata | [optional] + +### Return type + +[**CreateSessionResponse**](CreateSessionResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Session created | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + diff --git a/docs/apis/WebhookApi.md b/docs/apis/WebhookApi.md new file mode 100644 index 0000000000..453dd89319 --- /dev/null +++ b/docs/apis/WebhookApi.md @@ -0,0 +1,638 @@ +# apideck.WebhookApi + +All URIs are relative to *https://unify.apideck.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**event_logs_all**](WebhookApi.md#event_logs_all) | **GET** /webhook/logs | List event logs +[**webhooks_add**](WebhookApi.md#webhooks_add) | **POST** /webhook/webhooks | Create webhook subscription +[**webhooks_all**](WebhookApi.md#webhooks_all) | **GET** /webhook/webhooks | List webhook subscriptions +[**webhooks_delete**](WebhookApi.md#webhooks_delete) | **DELETE** /webhook/webhooks/{id} | Delete webhook subscription +[**webhooks_one**](WebhookApi.md#webhooks_one) | **GET** /webhook/webhooks/{id} | Get webhook subscription +[**webhooks_update**](WebhookApi.md#webhooks_update) | **PATCH** /webhook/webhooks/{id} | Update webhook subscription + + +# **event_logs_all** +> GetWebhookEventLogsResponse event_logs_all() + +List event logs + +List event logs + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import webhook_api +from apideck.model.get_webhook_event_logs_response import GetWebhookEventLogsResponse +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.webhook_event_logs_filter import WebhookEventLogsFilter +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = webhook_api.WebhookApi(api_client) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + cursor = "cursor_example" # str, none_type | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. (optional) + limit = 20 # int | Number of records to return (optional) if omitted the server will use the default value of 20 + filter = WebhookEventLogsFilter( + exclude_apis="vault,proxy", + service=WebhookEventLogsFilterService( + id="id_example", + ), + consumer_id="test_user_id", + entity_type="Connection", + event_type="vault.connection.callable", + ) # WebhookEventLogsFilter | Filter results (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + # List event logs + api_response = api_instance.event_logs_all(app_id=app_id, cursor=cursor, limit=limit, filter=filter) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling WebhookApi->event_logs_all: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **app_id** | **str**| The ID of your Unify application | [optional] + **cursor** | **str, none_type**| Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | [optional] + **limit** | **int**| Number of records to return | [optional] if omitted the server will use the default value of 20 + **filter** | **WebhookEventLogsFilter**| Filter results | [optional] + +### Return type + +[**GetWebhookEventLogsResponse**](GetWebhookEventLogsResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | EventLogs | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **webhooks_add** +> CreateWebhookResponse webhooks_add(create_webhook_request) + +Create webhook subscription + +Create a webhook subscription to receive events + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import webhook_api +from apideck.model.create_webhook_response import CreateWebhookResponse +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.create_webhook_request import CreateWebhookRequest +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = webhook_api.WebhookApi(api_client) + create_webhook_request = CreateWebhookRequest( + description="A description", + unified_api=UnifiedApiId("crm"), + status=Status("enabled"), + delivery_url=DeliveryUrl("https://example.com/my/webhook/endpoint"), + events=[ + WebhookEventType("["vault.connection.created","vault.connection.updated"]"), + ], + ) # CreateWebhookRequest | + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + + # example passing only required values which don't have defaults set + try: + # Create webhook subscription + api_response = api_instance.webhooks_add(create_webhook_request) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling WebhookApi->webhooks_add: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Create webhook subscription + api_response = api_instance.webhooks_add(create_webhook_request, app_id=app_id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling WebhookApi->webhooks_add: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **create_webhook_request** | [**CreateWebhookRequest**](CreateWebhookRequest.md)| | + **app_id** | **str**| The ID of your Unify application | [optional] + +### Return type + +[**CreateWebhookResponse**](CreateWebhookResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**201** | Webhooks | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **webhooks_all** +> GetWebhooksResponse webhooks_all() + +List webhook subscriptions + +List all webhook subscriptions + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import webhook_api +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.get_webhooks_response import GetWebhooksResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = webhook_api.WebhookApi(api_client) + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + cursor = "cursor_example" # str, none_type | Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. (optional) + limit = 20 # int | Number of records to return (optional) if omitted the server will use the default value of 20 + + # example passing only required values which don't have defaults set + # and optional values + try: + # List webhook subscriptions + api_response = api_instance.webhooks_all(app_id=app_id, cursor=cursor, limit=limit) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling WebhookApi->webhooks_all: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **app_id** | **str**| The ID of your Unify application | [optional] + **cursor** | **str, none_type**| Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. | [optional] + **limit** | **int**| Number of records to return | [optional] if omitted the server will use the default value of 20 + +### Return type + +[**GetWebhooksResponse**](GetWebhooksResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Webhooks | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **webhooks_delete** +> DeleteWebhookResponse webhooks_delete(id) + +Delete webhook subscription + +Delete a webhook subscription + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import webhook_api +from apideck.model.delete_webhook_response import DeleteWebhookResponse +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = webhook_api.WebhookApi(api_client) + id = "id_example" # str | JWT Webhook token that represents the unifiedApi and applicationId associated to the event source. + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + + # example passing only required values which don't have defaults set + try: + # Delete webhook subscription + api_response = api_instance.webhooks_delete(id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling WebhookApi->webhooks_delete: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Delete webhook subscription + api_response = api_instance.webhooks_delete(id, app_id=app_id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling WebhookApi->webhooks_delete: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| JWT Webhook token that represents the unifiedApi and applicationId associated to the event source. | + **app_id** | **str**| The ID of your Unify application | [optional] + +### Return type + +[**DeleteWebhookResponse**](DeleteWebhookResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Webhooks | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **webhooks_one** +> GetWebhookResponse webhooks_one(id) + +Get webhook subscription + +Get the webhook subscription details + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import webhook_api +from apideck.model.get_webhook_response import GetWebhookResponse +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = webhook_api.WebhookApi(api_client) + id = "id_example" # str | JWT Webhook token that represents the unifiedApi and applicationId associated to the event source. + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + + # example passing only required values which don't have defaults set + try: + # Get webhook subscription + api_response = api_instance.webhooks_one(id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling WebhookApi->webhooks_one: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get webhook subscription + api_response = api_instance.webhooks_one(id, app_id=app_id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling WebhookApi->webhooks_one: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| JWT Webhook token that represents the unifiedApi and applicationId associated to the event source. | + **app_id** | **str**| The ID of your Unify application | [optional] + +### Return type + +[**GetWebhookResponse**](GetWebhookResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Webhooks | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + +# **webhooks_update** +> UpdateWebhookResponse webhooks_update(id, update_webhook_request) + +Update webhook subscription + +Update a webhook subscription + +### Example + +* Api Key Authentication (apiKey): + +```python +import time +import apideck +from apideck.api import webhook_api +from apideck.model.update_webhook_response import UpdateWebhookResponse +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.not_found_response import NotFoundResponse +from apideck.model.update_webhook_request import UpdateWebhookRequest +from pprint import pprint +# Defining the host is optional and defaults to https://unify.apideck.com +# See configuration.py for a list of all supported configuration parameters. +configuration = apideck.Configuration( + host = "https://unify.apideck.com" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: apiKey +configuration.api_key['apiKey'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with apideck.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = webhook_api.WebhookApi(api_client) + id = "id_example" # str | JWT Webhook token that represents the unifiedApi and applicationId associated to the event source. + update_webhook_request = UpdateWebhookRequest( + description="A description", + status=Status("enabled"), + delivery_url=DeliveryUrl("https://example.com/my/webhook/endpoint"), + events=[ + WebhookEventType("["vault.connection.created","vault.connection.updated"]"), + ], + ) # UpdateWebhookRequest | + app_id = "x-apideck-app-id_example" # str | The ID of your Unify application (optional) + + # example passing only required values which don't have defaults set + try: + # Update webhook subscription + api_response = api_instance.webhooks_update(id, update_webhook_request) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling WebhookApi->webhooks_update: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Update webhook subscription + api_response = api_instance.webhooks_update(id, update_webhook_request, app_id=app_id) + pprint(api_response) + except apideck.ApiException as e: + print("Exception when calling WebhookApi->webhooks_update: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| JWT Webhook token that represents the unifiedApi and applicationId associated to the event source. | + **update_webhook_request** | [**UpdateWebhookRequest**](UpdateWebhookRequest.md)| | + **app_id** | **str**| The ID of your Unify application | [optional] + +### Return type + +[**UpdateWebhookResponse**](UpdateWebhookResponse.md) + +### Authorization + +[apiKey](../../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Webhooks | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**402** | Payment Required | - | +**404** | The specified resource was not found | - | +**422** | Unprocessable | - | +**0** | Unexpected error | - | + +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) + diff --git a/docs/models/AccountingCustomer.md b/docs/models/AccountingCustomer.md new file mode 100644 index 0000000000..b745ebec0c --- /dev/null +++ b/docs/models/AccountingCustomer.md @@ -0,0 +1,36 @@ +# AccountingCustomer + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | | [optional] [readonly] +**display_id** | **str, none_type** | Display ID | [optional] +**display_name** | **str, none_type** | Display Name | [optional] +**company_name** | **str, none_type** | | [optional] +**title** | **str, none_type** | | [optional] +**first_name** | **str, none_type** | | [optional] +**middle_name** | **str, none_type** | | [optional] +**last_name** | **str, none_type** | | [optional] +**suffix** | **str, none_type** | | [optional] +**individual** | **bool, none_type** | Is this an individual or business customer | [optional] +**addresses** | [**[Address]**](Address.md) | | [optional] +**notes** | **str, none_type** | Some notes about this customer | [optional] +**phone_numbers** | [**[PhoneNumber]**](PhoneNumber.md) | | [optional] +**emails** | [**[Email]**](Email.md) | | [optional] +**websites** | [**[Website]**](Website.md) | | [optional] +**tax_rate** | [**LinkedTaxRate**](LinkedTaxRate.md) | | [optional] +**tax_number** | **str, none_type** | | [optional] +**currency** | [**Currency**](Currency.md) | | [optional] +**bank_accounts** | [**[BankAccount]**](BankAccount.md) | | [optional] +**status** | **str, none_type** | Customer status | [optional] +**row_version** | **str, none_type** | | [optional] +**updated_by** | **str, none_type** | | [optional] [readonly] +**created_by** | **str, none_type** | | [optional] [readonly] +**updated_at** | **datetime** | | [optional] [readonly] +**created_at** | **datetime** | | [optional] [readonly] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/AccountingEventType.md b/docs/models/AccountingEventType.md new file mode 100644 index 0000000000..2ddd1a666a --- /dev/null +++ b/docs/models/AccountingEventType.md @@ -0,0 +1,11 @@ +# AccountingEventType + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **str** | | must be one of ["*", "accounting.customer.created", "accounting.customer.updated", "accounting.customer.deleted", "accounting.invoice.created", "accounting.invoice.updated", "accounting.invoice.deleted", "accounting.invoice_item.created", "accounting.invoice_item.updated", "accounting.invoice_item.deleted", "accounting.ledger_account.created", "accounting.ledger_account.updated", "accounting.ledger_account.deleted", "accounting.tax_rate.created", "accounting.tax_rate.updated", "accounting.tax_rate.deleted", "accounting.bill.created", "accounting.bill.updated", "accounting.bill.deleted", "accounting.payment.created", "accounting.payment.updated", "accounting.payment.deleted", "accounting.supplier.created", "accounting.supplier.updated", "accounting.supplier.deleted", ] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/Activity.md b/docs/models/Activity.md new file mode 100644 index 0000000000..54ba992844 --- /dev/null +++ b/docs/models/Activity.md @@ -0,0 +1,60 @@ +# Activity + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **str** | | +**id** | **str** | | [optional] [readonly] +**downstream_id** | **str, none_type** | The third-party API ID of original entity | [optional] [readonly] +**activity_datetime** | **str, none_type** | | [optional] +**duration_seconds** | **int, none_type** | | [optional] +**user_id** | **str, none_type** | | [optional] +**account_id** | **str, none_type** | | [optional] +**contact_id** | **str, none_type** | | [optional] +**company_id** | **str, none_type** | | [optional] +**opportunity_id** | **str, none_type** | | [optional] +**lead_id** | **str, none_type** | | [optional] +**owner_id** | **str, none_type** | | [optional] +**campaign_id** | **str, none_type** | | [optional] +**case_id** | **str, none_type** | | [optional] +**asset_id** | **str, none_type** | | [optional] +**contract_id** | **str, none_type** | | [optional] +**product_id** | **str, none_type** | | [optional] +**solution_id** | **str, none_type** | | [optional] +**custom_object_id** | **str, none_type** | | [optional] +**title** | **str, none_type** | | [optional] +**description** | **str, none_type** | | [optional] +**note** | **str, none_type** | | [optional] +**location** | **str, none_type** | | [optional] +**location_address** | [**Address**](Address.md) | | [optional] +**all_day_event** | **bool** | | [optional] +**private** | **bool** | | [optional] +**group_event** | **bool** | | [optional] +**event_sub_type** | **str, none_type** | | [optional] +**group_event_type** | **str, none_type** | | [optional] +**child** | **bool** | | [optional] +**archived** | **bool** | | [optional] +**deleted** | **bool** | | [optional] +**show_as** | **str** | | [optional] +**done** | **bool** | Whether the Activity is done or not | [optional] +**start_datetime** | **str, none_type** | | [optional] +**end_datetime** | **str, none_type** | | [optional] +**duration_minutes** | **int, none_type** | | [optional] [readonly] +**activity_date** | **str, none_type** | | [optional] +**end_date** | **str, none_type** | | [optional] +**recurrent** | **bool** | | [optional] +**reminder_datetime** | **str, none_type** | | [optional] +**reminder_set** | **bool, none_type** | | [optional] +**video_conference_url** | **str** | | [optional] +**video_conference_id** | **str** | | [optional] +**custom_fields** | [**[CustomField]**](CustomField.md) | | [optional] +**attendees** | [**[ActivityAttendee]**](ActivityAttendee.md) | | [optional] +**updated_by** | **str, none_type** | | [optional] [readonly] +**created_by** | **str, none_type** | | [optional] [readonly] +**updated_at** | **str** | | [optional] [readonly] +**created_at** | **str** | | [optional] [readonly] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/ActivityAttendee.md b/docs/models/ActivityAttendee.md new file mode 100644 index 0000000000..c12770de6f --- /dev/null +++ b/docs/models/ActivityAttendee.md @@ -0,0 +1,24 @@ +# ActivityAttendee + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | | [optional] [readonly] +**name** | **str** | | [optional] +**first_name** | **str, none_type** | | [optional] +**middle_name** | **str, none_type** | | [optional] +**last_name** | **str, none_type** | | [optional] +**prefix** | **str, none_type** | | [optional] +**suffix** | **str, none_type** | | [optional] +**email_address** | **str, none_type** | | [optional] +**is_organizer** | **bool, none_type** | | [optional] +**status** | **str, none_type** | | [optional] +**user_id** | **str** | | [optional] [readonly] +**contact_id** | **str** | | [optional] [readonly] +**updated_at** | **datetime** | | [optional] [readonly] +**created_at** | **datetime** | | [optional] [readonly] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/Address.md b/docs/models/Address.md new file mode 100644 index 0000000000..0c76d1ff93 --- /dev/null +++ b/docs/models/Address.md @@ -0,0 +1,33 @@ +# Address + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str, none_type** | | [optional] +**type** | **str** | | [optional] +**string** | **str, none_type** | | [optional] +**name** | **str, none_type** | | [optional] +**line1** | **str, none_type** | Line 1 of the address e.g. number, street, suite, apt #, etc. | [optional] +**line2** | **str, none_type** | Line 2 of the address | [optional] +**line3** | **str, none_type** | Line 3 of the address | [optional] +**line4** | **str, none_type** | Line 4 of the address | [optional] +**street_number** | **str, none_type** | Street number | [optional] +**city** | **str, none_type** | Name of city. | [optional] +**state** | **str, none_type** | Name of state | [optional] +**postal_code** | **str, none_type** | Zip code or equivalent. | [optional] +**country** | **str, none_type** | country code according to ISO 3166-1 alpha-2. | [optional] +**latitude** | **str, none_type** | | [optional] +**longitude** | **str, none_type** | | [optional] +**county** | **str, none_type** | Address field that holds a sublocality, such as a county | [optional] +**contact_name** | **str, none_type** | | [optional] +**salutation** | **str, none_type** | | [optional] +**phone_number** | **str, none_type** | | [optional] +**fax** | **str, none_type** | | [optional] +**email** | **str, none_type** | | [optional] +**website** | **str, none_type** | | [optional] +**row_version** | **str, none_type** | | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/ApiResource.md b/docs/models/ApiResource.md new file mode 100644 index 0000000000..60eb5d0a46 --- /dev/null +++ b/docs/models/ApiResource.md @@ -0,0 +1,16 @@ +# ApiResource + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | ID of the resource, typically a lowercased version of name. | [optional] +**name** | **str** | Name of the resource (plural) | [optional] +**status** | [**ResourceStatus**](ResourceStatus.md) | | [optional] +**linked_resources** | [**[ApiResourceLinkedResources]**](ApiResourceLinkedResources.md) | List of linked resources. | [optional] +**schema** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | JSON Schema of the resource in our Unified API | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/ApiResourceCoverage.md b/docs/models/ApiResourceCoverage.md new file mode 100644 index 0000000000..fae32fa823 --- /dev/null +++ b/docs/models/ApiResourceCoverage.md @@ -0,0 +1,15 @@ +# ApiResourceCoverage + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | ID of the resource, typically a lowercased version of name. | [optional] +**name** | **str** | Name of the resource (plural) | [optional] +**status** | [**ResourceStatus**](ResourceStatus.md) | | [optional] +**coverage** | [**[ApiResourceCoverageCoverage]**](ApiResourceCoverageCoverage.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/ApiResourceCoverageCoverage.md b/docs/models/ApiResourceCoverageCoverage.md new file mode 100644 index 0000000000..a4622e306a --- /dev/null +++ b/docs/models/ApiResourceCoverageCoverage.md @@ -0,0 +1,20 @@ +# ApiResourceCoverageCoverage + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**downstream_id** | **str** | ID of the resource in the Connector's API (downstream) | [optional] +**downstream_name** | **str** | Name of the resource in the Connector's API (downstream) | [optional] +**pagination_supported** | **bool** | Indicates if pagination (cursor and limit parameters) is supported on the list endpoint of the resource. | [optional] +**pagination** | [**PaginationCoverage**](PaginationCoverage.md) | | [optional] +**supported_operations** | **[str]** | List of supported operations on the resource. | [optional] +**supported_filters** | **[str]** | Supported filters on the list endpoint of the resource. | [optional] +**supported_sort_by** | **[str]** | Supported sorting properties on the list endpoint of the resource. | [optional] +**supported_fields** | [**[SupportedProperty]**](SupportedProperty.md) | Supported fields on the detail endpoint. | [optional] +**supported_list_fields** | [**[SupportedProperty]**](SupportedProperty.md) | Supported fields on the list endpoint. | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/ApiResourceLinkedResources.md b/docs/models/ApiResourceLinkedResources.md new file mode 100644 index 0000000000..555b8aefdd --- /dev/null +++ b/docs/models/ApiResourceLinkedResources.md @@ -0,0 +1,13 @@ +# ApiResourceLinkedResources + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | ID of the resource, typically a lowercased version of name. | [optional] +**unified_property** | **str** | Name of the property in our Unified API. | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/ApiResources.md b/docs/models/ApiResources.md new file mode 100644 index 0000000000..62ce213d76 --- /dev/null +++ b/docs/models/ApiResources.md @@ -0,0 +1,15 @@ +# ApiResources + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | ID of the resource, typically a lowercased version of its name. | [optional] +**name** | **str** | Name of the resource (plural) | [optional] +**status** | [**ResourceStatus**](ResourceStatus.md) | | [optional] +**excluded_from_coverage** | **bool** | Exclude from mapping coverage | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/ApiStatus.md b/docs/models/ApiStatus.md new file mode 100644 index 0000000000..f80e9ad779 --- /dev/null +++ b/docs/models/ApiStatus.md @@ -0,0 +1,12 @@ +# ApiStatus + +Status of the API. APIs with status live or beta are callable. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **str** | Status of the API. APIs with status live or beta are callable. | must be one of ["live", "beta", "development", "considering", ] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/ApisFilter.md b/docs/models/ApisFilter.md new file mode 100644 index 0000000000..467fb9d29e --- /dev/null +++ b/docs/models/ApisFilter.md @@ -0,0 +1,11 @@ +# ApisFilter + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status** | [**ApiStatus**](ApiStatus.md) | | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/Applicant.md b/docs/models/Applicant.md new file mode 100644 index 0000000000..7d6561e74b --- /dev/null +++ b/docs/models/Applicant.md @@ -0,0 +1,52 @@ +# Applicant + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | | [optional] [readonly] +**position_id** | **str** | The PositionId the applicant applied for. | [optional] +**name** | **str** | The name of an applicant. | [optional] +**first_name** | **str, none_type** | | [optional] +**last_name** | **str, none_type** | | [optional] +**middle_name** | **str, none_type** | | [optional] +**initials** | **str, none_type** | | [optional] +**birthday** | **date, none_type** | | [optional] +**cover_letter** | **str** | | [optional] +**job_url** | **str, none_type** | | [optional] [readonly] +**photo_url** | **str, none_type** | | [optional] +**headline** | **str** | Typically a list of previous companies where the contact has worked or schools that the contact has attended | [optional] +**title** | **str, none_type** | | [optional] +**emails** | [**[Email]**](Email.md) | | [optional] +**phone_numbers** | [**[PhoneNumber]**](PhoneNumber.md) | | [optional] +**addresses** | [**[Address]**](Address.md) | | [optional] +**websites** | [**[ApplicantWebsites]**](ApplicantWebsites.md) | | [optional] +**social_links** | [**[ApplicantSocialLinks]**](ApplicantSocialLinks.md) | | [optional] +**stage_id** | **str** | | [optional] +**recruiter_id** | **str** | | [optional] +**coordinator_id** | **str** | | [optional] +**applications** | **[str], none_type** | | [optional] +**followers** | **[str], none_type** | | [optional] +**sources** | **[str], none_type** | | [optional] +**source_id** | **str** | | [optional] [readonly] +**confidential** | **bool** | | [optional] +**anonymized** | **bool** | | [optional] +**tags** | [**Tags**](Tags.md) | | [optional] +**archived** | **bool** | | [optional] +**last_interaction_at** | **datetime** | | [optional] [readonly] +**owner_id** | **str** | | [optional] +**sourced_by** | **str, none_type** | | [optional] [readonly] +**cv_url** | **str** | | [optional] [readonly] +**record_url** | **str, none_type** | | [optional] +**rejected_at** | **datetime, none_type** | | [optional] [readonly] +**deleted** | **bool, none_type** | | [optional] +**deleted_by** | **str, none_type** | | [optional] [readonly] +**deleted_at** | **datetime, none_type** | | [optional] [readonly] +**updated_by** | **str, none_type** | | [optional] [readonly] +**created_by** | **str, none_type** | | [optional] [readonly] +**updated_at** | **datetime** | | [optional] [readonly] +**created_at** | **datetime** | | [optional] [readonly] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/ApplicantSocialLinks.md b/docs/models/ApplicantSocialLinks.md new file mode 100644 index 0000000000..b55e97fcce --- /dev/null +++ b/docs/models/ApplicantSocialLinks.md @@ -0,0 +1,14 @@ +# ApplicantSocialLinks + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**url** | **str** | | +**id** | **str, none_type** | | [optional] +**type** | **str, none_type** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/ApplicantWebsites.md b/docs/models/ApplicantWebsites.md new file mode 100644 index 0000000000..e4408f229f --- /dev/null +++ b/docs/models/ApplicantWebsites.md @@ -0,0 +1,14 @@ +# ApplicantWebsites + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**url** | **str** | | +**id** | **str, none_type** | | [optional] +**type** | **str** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/ApplicantsFilter.md b/docs/models/ApplicantsFilter.md new file mode 100644 index 0000000000..ff1f16d2f9 --- /dev/null +++ b/docs/models/ApplicantsFilter.md @@ -0,0 +1,11 @@ +# ApplicantsFilter + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**job_id** | **str** | Id of the job to filter on | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/AtsActivity.md b/docs/models/AtsActivity.md new file mode 100644 index 0000000000..c04f77047c --- /dev/null +++ b/docs/models/AtsActivity.md @@ -0,0 +1,15 @@ +# AtsActivity + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | | [optional] [readonly] +**updated_by** | **str, none_type** | | [optional] [readonly] +**created_by** | **str, none_type** | | [optional] [readonly] +**updated_at** | **datetime** | | [optional] [readonly] +**created_at** | **datetime** | | [optional] [readonly] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/AtsEventType.md b/docs/models/AtsEventType.md new file mode 100644 index 0000000000..ff33a9731a --- /dev/null +++ b/docs/models/AtsEventType.md @@ -0,0 +1,11 @@ +# AtsEventType + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **str** | | must be one of ["ats.job.created", "ats.job.updated", "ats.job.deleted", "ats.applicant.created", "ats.applicant.updated", "ats.applicant.deleted", ] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/AuthType.md b/docs/models/AuthType.md new file mode 100644 index 0000000000..670717f098 --- /dev/null +++ b/docs/models/AuthType.md @@ -0,0 +1,12 @@ +# AuthType + +Type of authorization used by the connector + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **str** | Type of authorization used by the connector | must be one of ["oauth2", "apiKey", "basic", "custom", "none", ] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/BadRequestResponse.md b/docs/models/BadRequestResponse.md new file mode 100644 index 0000000000..43cb82ffbc --- /dev/null +++ b/docs/models/BadRequestResponse.md @@ -0,0 +1,17 @@ +# BadRequestResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **float** | HTTP status code | [optional] +**error** | **str** | Contains an explanation of the status_code as defined in HTTP/1.1 standard (RFC 7231) | [optional] +**type_name** | **str** | The type of error returned | [optional] +**message** | **str** | A human-readable message providing more details about the error. | [optional] +**detail** | **bool, date, datetime, dict, float, int, list, str, none_type** | Contains parameter or domain specific information related to the error and why it occurred. | [optional] +**ref** | **str** | Link to documentation of error type | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/BalanceSheet.md b/docs/models/BalanceSheet.md new file mode 100644 index 0000000000..46aea421b4 --- /dev/null +++ b/docs/models/BalanceSheet.md @@ -0,0 +1,21 @@ +# BalanceSheet + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**report_name** | **str** | The name of the report | +**start_date** | **str** | The start date of the report | +**assets** | [**BalanceSheetAssets**](BalanceSheetAssets.md) | | +**liabilities** | [**BalanceSheetLiabilities**](BalanceSheetLiabilities.md) | | +**equity** | [**BalanceSheetEquity**](BalanceSheetEquity.md) | | +**id** | **str** | | [optional] [readonly] +**end_date** | **str** | The start date of the report | [optional] +**updated_by** | **str, none_type** | | [optional] [readonly] +**created_by** | **str, none_type** | | [optional] [readonly] +**updated_at** | **datetime** | | [optional] [readonly] +**created_at** | **datetime** | | [optional] [readonly] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/BalanceSheetAssets.md b/docs/models/BalanceSheetAssets.md new file mode 100644 index 0000000000..bf8ffeeb41 --- /dev/null +++ b/docs/models/BalanceSheetAssets.md @@ -0,0 +1,14 @@ +# BalanceSheetAssets + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**total** | **float** | Total assets | +**current_assets** | [**BalanceSheetAssetsCurrentAssets**](BalanceSheetAssetsCurrentAssets.md) | | +**fixed_assets** | [**BalanceSheetAssetsFixedAssets**](BalanceSheetAssetsFixedAssets.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/BalanceSheetAssetsCurrentAssets.md b/docs/models/BalanceSheetAssetsCurrentAssets.md new file mode 100644 index 0000000000..a2d653c996 --- /dev/null +++ b/docs/models/BalanceSheetAssetsCurrentAssets.md @@ -0,0 +1,13 @@ +# BalanceSheetAssetsCurrentAssets + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**total** | **float** | Total current assets | +**accounts** | [**[BalanceSheetAssetsCurrentAssetsAccounts]**](BalanceSheetAssetsCurrentAssetsAccounts.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/BalanceSheetAssetsCurrentAssetsAccounts.md b/docs/models/BalanceSheetAssetsCurrentAssetsAccounts.md new file mode 100644 index 0000000000..f47792994b --- /dev/null +++ b/docs/models/BalanceSheetAssetsCurrentAssetsAccounts.md @@ -0,0 +1,14 @@ +# BalanceSheetAssetsCurrentAssetsAccounts + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | | [optional] [readonly] +**name** | **str** | The name of the current asset account | [optional] +**value** | **float** | The value of the current asset | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/BalanceSheetAssetsFixedAssets.md b/docs/models/BalanceSheetAssetsFixedAssets.md new file mode 100644 index 0000000000..e9b0b77444 --- /dev/null +++ b/docs/models/BalanceSheetAssetsFixedAssets.md @@ -0,0 +1,13 @@ +# BalanceSheetAssetsFixedAssets + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**total** | **float** | Total fixed assets | +**accounts** | [**[BalanceSheetAssetsFixedAssetsAccounts]**](BalanceSheetAssetsFixedAssetsAccounts.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/BalanceSheetAssetsFixedAssetsAccounts.md b/docs/models/BalanceSheetAssetsFixedAssetsAccounts.md new file mode 100644 index 0000000000..41904dbdde --- /dev/null +++ b/docs/models/BalanceSheetAssetsFixedAssetsAccounts.md @@ -0,0 +1,14 @@ +# BalanceSheetAssetsFixedAssetsAccounts + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | | [optional] [readonly] +**name** | **str** | The name of the fixed asset account | [optional] +**value** | **float** | The value of the fixed asset | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/BalanceSheetEquity.md b/docs/models/BalanceSheetEquity.md new file mode 100644 index 0000000000..d4222a4f7c --- /dev/null +++ b/docs/models/BalanceSheetEquity.md @@ -0,0 +1,13 @@ +# BalanceSheetEquity + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**total** | **float** | Total equity | +**items** | [**[BalanceSheetEquityItems]**](BalanceSheetEquityItems.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/BalanceSheetEquityItems.md b/docs/models/BalanceSheetEquityItems.md new file mode 100644 index 0000000000..eb45a10b3a --- /dev/null +++ b/docs/models/BalanceSheetEquityItems.md @@ -0,0 +1,14 @@ +# BalanceSheetEquityItems + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | | [optional] [readonly] +**name** | **str** | The type of the equity | [optional] +**value** | **float** | The equity amount | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/BalanceSheetFilter.md b/docs/models/BalanceSheetFilter.md new file mode 100644 index 0000000000..7b87678c13 --- /dev/null +++ b/docs/models/BalanceSheetFilter.md @@ -0,0 +1,12 @@ +# BalanceSheetFilter + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**start_date** | **str** | Filter by start date. If start date is given, end date is required. | [optional] +**end_date** | **str** | Filter by end date. If end date is given, start date is required. | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/BalanceSheetLiabilities.md b/docs/models/BalanceSheetLiabilities.md new file mode 100644 index 0000000000..7f06ba8af7 --- /dev/null +++ b/docs/models/BalanceSheetLiabilities.md @@ -0,0 +1,13 @@ +# BalanceSheetLiabilities + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**total** | **float** | Total liabilities | +**accounts** | [**[BalanceSheetLiabilitiesAccounts]**](BalanceSheetLiabilitiesAccounts.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/BalanceSheetLiabilitiesAccounts.md b/docs/models/BalanceSheetLiabilitiesAccounts.md new file mode 100644 index 0000000000..8df699e322 --- /dev/null +++ b/docs/models/BalanceSheetLiabilitiesAccounts.md @@ -0,0 +1,14 @@ +# BalanceSheetLiabilitiesAccounts + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | | [optional] [readonly] +**name** | **str** | The name of the liability account | [optional] +**value** | **float** | The value of the liability | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/BankAccount.md b/docs/models/BankAccount.md new file mode 100644 index 0000000000..622e5f0fcd --- /dev/null +++ b/docs/models/BankAccount.md @@ -0,0 +1,19 @@ +# BankAccount + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**iban** | **str, none_type** | | [optional] +**bic** | **str, none_type** | | [optional] +**bsb_number** | **str, none_type** | A BSB is a 6 digit numeric code used for identifying the branch of an Australian or New Zealand bank or financial institution. | [optional] +**branch_identifier** | **str, none_type** | A branch identifier is a unique identifier for a branch of a bank or financial institution. | [optional] +**bank_code** | **str, none_type** | A bank code is a code assigned by a central bank, a bank supervisory body or a Bankers Association in a country to all its licensed member banks or financial institutions. | [optional] +**account_number** | **str, none_type** | A bank account number is a number that is tied to your bank account. If you have several bank accounts, such as personal, joint, business (and so on), each account will have a different account number. | [optional] +**account_name** | **str, none_type** | The name which you used in opening your bank account. | [optional] +**account_type** | **str, none_type** | The type of bank account. | [optional] +**currency** | [**Currency**](Currency.md) | | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/Benefit.md b/docs/models/Benefit.md new file mode 100644 index 0000000000..796c531ac6 --- /dev/null +++ b/docs/models/Benefit.md @@ -0,0 +1,14 @@ +# Benefit + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | The name of the benefit. | [optional] +**employee_deduction** | **float** | The amount deducted for benefit. | [optional] +**employer_contribution** | **float** | The amount of employer contribution. | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/Bill.md b/docs/models/Bill.md new file mode 100644 index 0000000000..e55766fdd4 --- /dev/null +++ b/docs/models/Bill.md @@ -0,0 +1,38 @@ +# Bill + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | | [optional] [readonly] +**downstream_id** | **str, none_type** | The third-party API ID of original entity | [optional] [readonly] +**supplier** | [**LinkedSupplier**](LinkedSupplier.md) | | [optional] +**currency** | [**Currency**](Currency.md) | | [optional] +**currency_rate** | **float, none_type** | Currency Exchange Rate at the time entity was recorded/generated. | [optional] +**tax_inclusive** | **bool, none_type** | Amounts are including tax | [optional] +**bill_date** | **date** | Date bill was issued - YYYY-MM-DD. | [optional] +**due_date** | **date** | The due date is the date on which a payment is scheduled to be received by the supplier - YYYY-MM-DD. | [optional] +**paid_date** | **date, none_type** | The paid date is the date on which a payment was sent to the supplier - YYYY-MM-DD. | [optional] +**po_number** | **str, none_type** | A PO Number uniquely identifies a purchase order and is generally defined by the buyer. The buyer will match the PO number in the invoice to the Purchase Order. | [optional] +**reference** | **str, none_type** | Optional invoice reference. | [optional] +**line_items** | [**[BillLineItem]**](BillLineItem.md) | | [optional] +**terms** | **str, none_type** | Terms of payment. | [optional] +**balance** | **float, none_type** | Balance of bill due. | [optional] +**deposit** | **float, none_type** | Amount of deposit made to this bill. | [optional] +**sub_total** | **float, none_type** | Sub-total amount, normally before tax. | [optional] +**total_tax** | **float, none_type** | Total tax amount applied to this bill. | [optional] +**total** | **float, none_type** | Total amount of bill, including tax. | [optional] +**tax_code** | **str, none_type** | Applicable tax id/code override if tax is not supplied on a line item basis. | [optional] +**notes** | **str, none_type** | | [optional] +**status** | **str, none_type** | Invoice status | [optional] +**ledger_account** | [**LinkedLedgerAccount**](LinkedLedgerAccount.md) | | [optional] +**bill_number** | **str, none_type** | | [optional] +**updated_by** | **str, none_type** | | [optional] [readonly] +**created_by** | **str, none_type** | | [optional] [readonly] +**updated_at** | **datetime** | | [optional] [readonly] +**created_at** | **datetime** | | [optional] [readonly] +**row_version** | **str, none_type** | | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/BillLineItem.md b/docs/models/BillLineItem.md new file mode 100644 index 0000000000..5f74c3985e --- /dev/null +++ b/docs/models/BillLineItem.md @@ -0,0 +1,32 @@ +# BillLineItem + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | | [optional] [readonly] +**row_id** | **str** | Row ID | [optional] +**code** | **str, none_type** | User defined item code | [optional] +**line_number** | **int, none_type** | Line number in the invoice | [optional] +**description** | **str, none_type** | User defined description | [optional] +**type** | **str, none_type** | Bill Line Item type | [optional] +**tax_amount** | **float, none_type** | Tax amount | [optional] +**total_amount** | **float, none_type** | Total amount of the line item | [optional] +**quantity** | **float, none_type** | | [optional] +**unit_price** | **float, none_type** | | [optional] +**unit_of_measure** | **str, none_type** | Description of the unit type the item is sold as, ie: kg, hour. | [optional] +**discount_percentage** | **float, none_type** | Discount percentage | [optional] +**location_id** | **str, none_type** | Location id | [optional] +**department_id** | **str, none_type** | Department id | [optional] +**item** | [**LinkedInvoiceItem**](LinkedInvoiceItem.md) | | [optional] +**ledger_account** | [**LinkedLedgerAccount**](LinkedLedgerAccount.md) | | [optional] +**tax_rate** | [**LinkedTaxRate**](LinkedTaxRate.md) | | [optional] +**row_version** | **str, none_type** | | [optional] +**updated_by** | **str, none_type** | | [optional] [readonly] +**created_by** | **str, none_type** | | [optional] [readonly] +**created_at** | **datetime** | | [optional] [readonly] +**updated_at** | **datetime** | | [optional] [readonly] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/Branch.md b/docs/models/Branch.md new file mode 100644 index 0000000000..25a05f2a2d --- /dev/null +++ b/docs/models/Branch.md @@ -0,0 +1,14 @@ +# Branch + +Details of the branch for which the job is created. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | | [optional] [readonly] +**name** | **str** | Name of the branch. | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/CashDetails.md b/docs/models/CashDetails.md new file mode 100644 index 0000000000..b3401cfc08 --- /dev/null +++ b/docs/models/CashDetails.md @@ -0,0 +1,14 @@ +# CashDetails + +Cash details for this payment + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**amount** | **bool, date, datetime, dict, float, int, list, str, none_type** | The amount of cash given by the customer. | [optional] +**charge_back_amount** | **bool, date, datetime, dict, float, int, list, str, none_type** | The amount of change due back to the buyer. For Square: this read-only field is calculated from the amount_money and buyer_supplied_money fields. | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/CompaniesFilter.md b/docs/models/CompaniesFilter.md new file mode 100644 index 0000000000..b603d85f7e --- /dev/null +++ b/docs/models/CompaniesFilter.md @@ -0,0 +1,11 @@ +# CompaniesFilter + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Name of the company to filter on | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/CompaniesSort.md b/docs/models/CompaniesSort.md new file mode 100644 index 0000000000..4c63182fd4 --- /dev/null +++ b/docs/models/CompaniesSort.md @@ -0,0 +1,12 @@ +# CompaniesSort + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**by** | **str** | The field on which to sort the Companies | [optional] +**direction** | [**SortDirection**](SortDirection.md) | | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/Company.md b/docs/models/Company.md new file mode 100644 index 0000000000..79e5558de7 --- /dev/null +++ b/docs/models/Company.md @@ -0,0 +1,50 @@ +# Company + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | | +**id** | **str** | | [optional] [readonly] +**interaction_count** | **int, none_type** | | [optional] [readonly] +**owner_id** | **str** | | [optional] +**image** | **str, none_type** | | [optional] +**description** | **str, none_type** | | [optional] +**vat_number** | **str, none_type** | VAT number | [optional] +**currency** | [**Currency**](Currency.md) | | [optional] +**status** | **str, none_type** | | [optional] +**fax** | **str, none_type** | | [optional] +**annual_revenue** | **str, none_type** | Annual revenue | [optional] +**number_of_employees** | **str, none_type** | Number of employees | [optional] +**industry** | **str, none_type** | Industry | [optional] +**ownership** | **str, none_type** | Ownership | [optional] +**sales_tax_number** | **str, none_type** | | [optional] +**payee_number** | **str, none_type** | | [optional] +**abn_or_tfn** | **str, none_type** | An ABN is necessary for operating a business, while a TFN (Tax File Number) is required for any person working in Australia. | [optional] +**abn_branch** | **str, none_type** | An ABN Branch (also known as a GST Branch) is used if part of your business needs to account for GST separately from its parent entity. | [optional] +**acn** | **str, none_type** | The Australian Company Number (ACN) is a nine digit number with the last digit being a check digit calculated using a modified modulus 10 calculation. ASIC has adopted a convention of always printing and displaying the ACN in the format XXX XXX XXX; three blocks of three characters, each block separated by a blank. | [optional] +**first_name** | **str, none_type** | | [optional] +**last_name** | **str, none_type** | | [optional] +**parent_id** | **str** | Parent ID | [optional] [readonly] +**bank_accounts** | [**[BankAccount]**](BankAccount.md) | | [optional] +**websites** | [**[Website]**](Website.md) | | [optional] +**addresses** | [**[Address]**](Address.md) | | [optional] +**social_links** | [**[SocialLink]**](SocialLink.md) | | [optional] +**phone_numbers** | [**[PhoneNumber]**](PhoneNumber.md) | | [optional] +**emails** | [**[Email]**](Email.md) | | [optional] +**row_type** | [**CompanyRowType**](CompanyRowType.md) | | [optional] +**custom_fields** | [**[CustomField]**](CustomField.md) | | [optional] +**tags** | [**Tags**](Tags.md) | | [optional] +**read_only** | **bool, none_type** | | [optional] +**last_activity_at** | **datetime, none_type** | | [optional] [readonly] +**deleted** | **bool** | | [optional] [readonly] +**salutation** | **str, none_type** | | [optional] +**birthday** | **date, none_type** | | [optional] +**updated_by** | **str, none_type** | | [optional] [readonly] +**created_by** | **str, none_type** | | [optional] [readonly] +**updated_at** | **datetime** | | [optional] [readonly] +**created_at** | **datetime** | | [optional] [readonly] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/CompanyInfo.md b/docs/models/CompanyInfo.md new file mode 100644 index 0000000000..6793e31dee --- /dev/null +++ b/docs/models/CompanyInfo.md @@ -0,0 +1,31 @@ +# CompanyInfo + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | | [optional] [readonly] +**company_name** | **str, none_type** | | [optional] +**status** | **str** | Based on the status some functionality is enabled or disabled. | [optional] +**legal_name** | **str** | The legal name of the company | [optional] +**country** | **str, none_type** | country code according to ISO 3166-1 alpha-2. | [optional] +**sales_tax_number** | **str, none_type** | | [optional] +**automated_sales_tax** | **bool** | Whether sales tax is calculated automatically for the company | [optional] +**sales_tax_enabled** | **bool** | Whether sales tax is enabled for the company | [optional] +**default_sales_tax** | [**LinkedTaxRate**](LinkedTaxRate.md) | | [optional] +**currency** | [**Currency**](Currency.md) | | [optional] +**language** | **str, none_type** | language code according to ISO 639-1. For the United States - EN | [optional] +**fiscal_year_start_month** | **str** | The start month of fiscal year. | [optional] +**company_start_date** | **date** | Date when company file was created | [optional] +**addresses** | [**[Address]**](Address.md) | | [optional] +**phone_numbers** | [**[PhoneNumber]**](PhoneNumber.md) | | [optional] +**emails** | [**[Email]**](Email.md) | | [optional] +**row_version** | **str, none_type** | | [optional] +**updated_by** | **str, none_type** | | [optional] [readonly] +**created_by** | **str, none_type** | | [optional] [readonly] +**updated_at** | **datetime** | | [optional] [readonly] +**created_at** | **datetime** | | [optional] [readonly] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/CompanyRowType.md b/docs/models/CompanyRowType.md new file mode 100644 index 0000000000..7fc1c31b7b --- /dev/null +++ b/docs/models/CompanyRowType.md @@ -0,0 +1,13 @@ +# CompanyRowType + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | | [optional] +**name** | **str** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/Compensation.md b/docs/models/Compensation.md new file mode 100644 index 0000000000..207a4d16d0 --- /dev/null +++ b/docs/models/Compensation.md @@ -0,0 +1,16 @@ +# Compensation + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**employee_id** | **str** | | [readonly] +**net_pay** | **float** | The employee's net pay. Only available when payroll has been processed | [optional] +**gross_pay** | **float** | The employee's gross pay. Only available when payroll has been processed | [optional] +**taxes** | [**[Tax]**](Tax.md) | An array of employer and employee taxes for the pay period. | [optional] +**deductions** | [**[Deduction]**](Deduction.md) | An array of employee deductions for the pay period. | [optional] +**benefits** | [**[Benefit]**](Benefit.md) | An array of employee benefits for the pay period. | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/Connection.md b/docs/models/Connection.md new file mode 100644 index 0000000000..f14f779ffa --- /dev/null +++ b/docs/models/Connection.md @@ -0,0 +1,38 @@ +# Connection + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The unique identifier of the connection. | [optional] [readonly] +**service_id** | **str** | The ID of the service this connection belongs to. | [optional] [readonly] +**name** | **str** | The name of the connection | [optional] [readonly] +**tag_line** | **str** | | [optional] [readonly] +**unified_api** | **str** | The unified API category where the connection belongs to. | [optional] [readonly] +**state** | [**ConnectionState**](ConnectionState.md) | | [optional] +**auth_type** | [**AuthType**](AuthType.md) | | [optional] +**oauth_grant_type** | [**OAuthGrantType**](OAuthGrantType.md) | | [optional] +**status** | **str** | Status of the connection. | [optional] [readonly] +**enabled** | **bool** | Whether the connection is enabled or not. You can enable or disable a connection using the Update Connection API. | [optional] +**website** | **str** | The website URL of the connection | [optional] [readonly] +**icon** | **str** | A visual icon of the connection, that will be shown in the Vault | [optional] [readonly] +**logo** | **str** | The logo of the connection, that will be shown in the Vault | [optional] [readonly] +**authorize_url** | **str, none_type** | The OAuth redirect URI. Redirect your users to this URI to let them authorize your app in the connector's UI. Before you can use this URI, you must add `redirect_uri` as a query parameter. Your users will be redirected to this `redirect_uri` after they granted access to your app in the connector's UI. | [optional] [readonly] +**revoke_url** | **str, none_type** | The OAuth revoke URI. Redirect your users to this URI to revoke this connection. Before you can use this URI, you must add `redirect_uri` as a query parameter. Your users will be redirected to this `redirect_uri` after they granted access to your app in the connector's UI. | [optional] [readonly] +**settings** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type** | Connection settings. Values will persist to `form_fields` with corresponding id | [optional] +**metadata** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type** | Attach your own consumer specific metadata | [optional] +**form_fields** | [**[FormField]**](FormField.md) | The settings that are wanted to create a connection. | [optional] [readonly] +**configuration** | [**[ConnectionConfiguration]**](ConnectionConfiguration.md) | | [optional] +**configurable_resources** | **[str]** | | [optional] [readonly] +**resource_schema_support** | **[str]** | | [optional] [readonly] +**resource_settings_support** | **[str]** | | [optional] [readonly] +**settings_required_for_authorization** | **[str]** | List of settings that are required to be configured on integration before authorization can occur | [optional] [readonly] +**subscriptions** | [**[WebhookSubscription]**](WebhookSubscription.md) | | [optional] [readonly] +**has_guide** | **bool** | Whether the connector has a guide available in the developer docs or not (https://docs.apideck.com/connectors/{service_id}/docs/consumer+connection). | [optional] [readonly] +**created_at** | **float** | | [optional] [readonly] +**updated_at** | **float, none_type** | | [optional] [readonly] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/ConnectionConfiguration.md b/docs/models/ConnectionConfiguration.md new file mode 100644 index 0000000000..d4427fa225 --- /dev/null +++ b/docs/models/ConnectionConfiguration.md @@ -0,0 +1,13 @@ +# ConnectionConfiguration + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**resource** | **str** | | [optional] +**defaults** | [**[ConnectionDefaults]**](ConnectionDefaults.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/ConnectionDefaults.md b/docs/models/ConnectionDefaults.md new file mode 100644 index 0000000000..3f3c184788 --- /dev/null +++ b/docs/models/ConnectionDefaults.md @@ -0,0 +1,15 @@ +# ConnectionDefaults + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**target** | **str** | | [optional] [readonly] +**id** | **str** | | [optional] +**options** | [**[FormFieldOption]**](FormFieldOption.md) | | [optional] +**value** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/ConnectionImportData.md b/docs/models/ConnectionImportData.md new file mode 100644 index 0000000000..381b36a3c5 --- /dev/null +++ b/docs/models/ConnectionImportData.md @@ -0,0 +1,14 @@ +# ConnectionImportData + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**credentials** | [**ConnectionImportDataCredentials**](ConnectionImportDataCredentials.md) | | [optional] +**settings** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type** | Connection settings. Values will persist to `form_fields` with corresponding id | [optional] +**metadata** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type** | Attach your own consumer specific metadata | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/ConnectionImportDataCredentials.md b/docs/models/ConnectionImportDataCredentials.md new file mode 100644 index 0000000000..3470ccb47f --- /dev/null +++ b/docs/models/ConnectionImportDataCredentials.md @@ -0,0 +1,15 @@ +# ConnectionImportDataCredentials + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**refresh_token** | **str** | The refresh token can be used to obtain a new access token. | +**access_token** | **str** | Access token | [optional] +**issued_at** | **datetime, none_type** | The datetime at which the token was issued. If omitted the token will be queued for refresh. | [optional] +**expires_in** | **int, none_type** | The number of seconds until the token expires. If omitted the token will be queued for refresh. | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/ConnectionMetadata.md b/docs/models/ConnectionMetadata.md new file mode 100644 index 0000000000..f594dc5575 --- /dev/null +++ b/docs/models/ConnectionMetadata.md @@ -0,0 +1,13 @@ +# ConnectionMetadata + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | | [optional] +**name** | **str** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/ConnectionState.md b/docs/models/ConnectionState.md new file mode 100644 index 0000000000..31135a47c0 --- /dev/null +++ b/docs/models/ConnectionState.md @@ -0,0 +1,12 @@ +# ConnectionState + +[Connection state flow](#section/Connection-state) + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **str** | [Connection state flow](#section/Connection-state) | must be one of ["available", "callable", "added", "authorized", ] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/ConnectionWebhook.md b/docs/models/ConnectionWebhook.md new file mode 100644 index 0000000000..4a1139f4e7 --- /dev/null +++ b/docs/models/ConnectionWebhook.md @@ -0,0 +1,19 @@ +# ConnectionWebhook + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**unified_api** | [**UnifiedApiId**](UnifiedApiId.md) | | +**status** | **str** | The status of the webhook. | +**delivery_url** | **str** | The delivery url of the webhook endpoint. | +**execute_base_url** | **str** | The Unify Base URL events from connectors will be sent to after service id is appended. | [readonly] +**events** | **[str]** | The list of subscribed events for this webhook. [`*`] indicates that all events are enabled. | +**id** | **str** | | [optional] [readonly] +**description** | **str, none_type** | | [optional] +**updated_at** | **datetime** | | [optional] [readonly] +**created_at** | **datetime** | | [optional] [readonly] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/Connector.md b/docs/models/Connector.md new file mode 100644 index 0000000000..7866e40a6e --- /dev/null +++ b/docs/models/Connector.md @@ -0,0 +1,37 @@ +# Connector + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | ID of the connector. | [optional] [readonly] +**name** | **str** | Name of the connector. | [optional] +**status** | [**ConnectorStatus**](ConnectorStatus.md) | | [optional] +**description** | **str, none_type** | | [optional] +**icon_url** | **str** | Link to a small square icon for the connector. | [optional] +**logo_url** | **str** | Link to the full logo for the connector. | [optional] +**website_url** | **str** | Link to the connector's website. | [optional] +**signup_url** | **str** | Link to the connector's signup page. | [optional] +**free_trial_available** | **bool** | Set to `true` when the connector offers a free trial. Use `signup_url` to sign up for a free trial | [optional] +**auth_type** | **str** | Type of authorization used by the connector | [optional] [readonly] +**auth_only** | **bool** | Indicates whether a connector only supports authentication. In this case the connector is not mapped to a Unified API, but can be used with the Proxy API | [optional] [readonly] +**blind_mapped** | **bool** | Set to `true` when connector was implemented from downstream docs only and without API access. This state indicates that integration will require Apideck support, and access to downstream API to validate mapping quality. | [optional] [readonly] +**oauth_grant_type** | **str** | OAuth grant type used by the connector. More info: https://oauth.net/2/grant-types | [optional] [readonly] +**oauth_credentials_source** | **str** | Location of the OAuth client credentials. For most connectors the OAuth client credentials are stored on integration and managed by the application owner. For others they are stored on connection and managed by the consumer in Vault. | [optional] [readonly] +**oauth_scopes** | [**[ConnectorOauthScopes]**](ConnectorOauthScopes.md) | List of OAuth Scopes available for this connector. | [optional] +**custom_scopes** | **bool** | Set to `true` when connector allows the definition of custom scopes. | [optional] [readonly] +**has_sandbox_credentials** | **bool** | Indicates whether Apideck Sandbox OAuth credentials are available. | [optional] +**settings** | [**[ConnectorSetting]**](ConnectorSetting.md) | | [optional] +**service_id** | **str** | Service provider identifier | [optional] +**unified_apis** | [**[ConnectorUnifiedApis]**](ConnectorUnifiedApis.md) | List of Unified APIs that feature this connector. | [optional] +**supported_resources** | [**[LinkedConnectorResource]**](LinkedConnectorResource.md) | List of resources that are supported on the connector. | [optional] +**configurable_resources** | **[str]** | List of resources that have settings that can be configured. | [optional] +**supported_events** | [**[ConnectorEvent]**](ConnectorEvent.md) | List of events that are supported on the connector across all Unified APIs. | [optional] +**webhook_support** | [**[WebhookSupport]**](WebhookSupport.md) | How webhooks are supported for the connector. Sometimes the connector natively supports webhooks, other times Apideck virtualizes them based on polling. | [optional] +**docs** | [**[ConnectorDoc]**](ConnectorDoc.md) | | [optional] +**tls_support** | [**ConnectorTlsSupport**](ConnectorTlsSupport.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/ConnectorDoc.md b/docs/models/ConnectorDoc.md new file mode 100644 index 0000000000..f11037bd6d --- /dev/null +++ b/docs/models/ConnectorDoc.md @@ -0,0 +1,16 @@ +# ConnectorDoc + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | | [optional] [readonly] +**name** | **str** | Name of the doc. | [optional] +**audience** | **str** | Audience for the doc. | [optional] +**format** | **str** | Format of the doc. | [optional] if omitted the server will use the default value of "markdown" +**url** | **str** | Link to fetch the content of the doc. | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/ConnectorEvent.md b/docs/models/ConnectorEvent.md new file mode 100644 index 0000000000..0256a606e6 --- /dev/null +++ b/docs/models/ConnectorEvent.md @@ -0,0 +1,16 @@ +# ConnectorEvent + +Unify event that is supported on the connector. Events are delivered via Webhooks. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**event_type** | **str** | Unify event type | [optional] +**event_source** | **str** | Unify event source | [optional] +**downstream_event_type** | **str** | Downstream event type | [optional] +**resource** | **str** | ID of the resource, typically a lowercased version of name. | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/ConnectorOauthScopes.md b/docs/models/ConnectorOauthScopes.md new file mode 100644 index 0000000000..51a8b7410a --- /dev/null +++ b/docs/models/ConnectorOauthScopes.md @@ -0,0 +1,14 @@ +# ConnectorOauthScopes + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | ID of the OAuth scope. | [optional] +**label** | **str** | Label of the OAuth scope. | [optional] +**default_apis** | **[str]** | List of Unified APIs that request this OAuth Scope by default. Application owners can customize the requested scopes. | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/ConnectorOauthScopes1.md b/docs/models/ConnectorOauthScopes1.md new file mode 100644 index 0000000000..0f9bba6137 --- /dev/null +++ b/docs/models/ConnectorOauthScopes1.md @@ -0,0 +1,14 @@ +# ConnectorOauthScopes1 + +OAuth scopes required for the connector. Add these scopes to your OAuth app. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | ID of the OAuth scope. | [optional] +**label** | **str** | Label of the OAuth scope. | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/ConnectorResource.md b/docs/models/ConnectorResource.md new file mode 100644 index 0000000000..e0be10c6a6 --- /dev/null +++ b/docs/models/ConnectorResource.md @@ -0,0 +1,25 @@ +# ConnectorResource + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | ID of the resource, typically a lowercased version of name. | [optional] +**name** | **str** | Name of the resource (plural) | [optional] +**downstream_id** | **str** | ID of the resource in the Connector's API (downstream) | [optional] +**downstream_name** | **str** | Name of the resource in the Connector's API (downstream) | [optional] +**status** | [**ResourceStatus**](ResourceStatus.md) | | [optional] +**pagination_supported** | **bool** | Indicates if pagination (cursor and limit parameters) is supported on the list endpoint of the resource. | [optional] +**pagination** | [**PaginationCoverage**](PaginationCoverage.md) | | [optional] +**custom_fields_supported** | **bool** | Indicates if custom fields are supported on this resource. | [optional] +**supported_operations** | **[str]** | List of supported operations on the resource. | [optional] +**downstream_unsupported_operations** | **[str]** | List of operations that are not supported on the downstream. | [optional] +**supported_filters** | **[str]** | Supported filters on the list endpoint of the resource. | [optional] +**supported_sort_by** | **[str]** | Supported sorting properties on the list endpoint of the resource. | [optional] +**supported_fields** | [**[SupportedProperty]**](SupportedProperty.md) | Supported fields on the detail endpoint. | [optional] +**supported_list_fields** | [**[SupportedProperty]**](SupportedProperty.md) | Supported fields on the list endpoint. | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/ConnectorSetting.md b/docs/models/ConnectorSetting.md new file mode 100644 index 0000000000..d7027fd353 --- /dev/null +++ b/docs/models/ConnectorSetting.md @@ -0,0 +1,14 @@ +# ConnectorSetting + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | | [optional] +**label** | **str** | | [optional] +**type** | **str** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/ConnectorStatus.md b/docs/models/ConnectorStatus.md new file mode 100644 index 0000000000..da8d769f0a --- /dev/null +++ b/docs/models/ConnectorStatus.md @@ -0,0 +1,12 @@ +# ConnectorStatus + +Status of the connector. Connectors with status live or beta are callable. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **str** | Status of the connector. Connectors with status live or beta are callable. | must be one of ["live", "beta", "development", "considering", ] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/ConnectorTlsSupport.md b/docs/models/ConnectorTlsSupport.md new file mode 100644 index 0000000000..b346cdcc97 --- /dev/null +++ b/docs/models/ConnectorTlsSupport.md @@ -0,0 +1,13 @@ +# ConnectorTlsSupport + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **str** | | [optional] +**description** | **str** | Description of the TLS support | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/ConnectorUnifiedApis.md b/docs/models/ConnectorUnifiedApis.md new file mode 100644 index 0000000000..f11b7376af --- /dev/null +++ b/docs/models/ConnectorUnifiedApis.md @@ -0,0 +1,17 @@ +# ConnectorUnifiedApis + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | [**UnifiedApiId**](UnifiedApiId.md) | | [optional] +**name** | **str** | Name of the API. | [optional] +**oauth_scopes** | [**[ConnectorOauthScopes1]**](ConnectorOauthScopes1.md) | | [optional] +**supported_resources** | [**[LinkedConnectorResource]**](LinkedConnectorResource.md) | List of resources that are supported on the connector. | [optional] +**downstream_unsupported_resources** | **[str]** | List of resources that are not supported on the downstream. | [optional] +**supported_events** | [**[ConnectorEvent]**](ConnectorEvent.md) | List of events that are supported on the connector for this Unified API. | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/ConnectorsFilter.md b/docs/models/ConnectorsFilter.md new file mode 100644 index 0000000000..846ddfaa4a --- /dev/null +++ b/docs/models/ConnectorsFilter.md @@ -0,0 +1,12 @@ +# ConnectorsFilter + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**unified_api** | [**UnifiedApiId**](UnifiedApiId.md) | | [optional] +**status** | [**ConnectorStatus**](ConnectorStatus.md) | | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/Consumer.md b/docs/models/Consumer.md new file mode 100644 index 0000000000..7d39518a6c --- /dev/null +++ b/docs/models/Consumer.md @@ -0,0 +1,21 @@ +# Consumer + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**consumer_id** | **str** | | [optional] +**application_id** | **str** | | [optional] +**metadata** | [**ConsumerMetadata**](ConsumerMetadata.md) | | [optional] +**connections** | [**[ConsumerConnection]**](ConsumerConnection.md) | | [optional] +**services** | **[str]** | | [optional] +**aggregated_request_count** | **float** | | [optional] +**request_counts** | [**RequestCountAllocation**](RequestCountAllocation.md) | | [optional] +**created** | **str** | | [optional] +**modified** | **str** | | [optional] +**request_count_updated** | **str** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/ConsumerConnection.md b/docs/models/ConsumerConnection.md new file mode 100644 index 0000000000..86d48eb7c9 --- /dev/null +++ b/docs/models/ConsumerConnection.md @@ -0,0 +1,27 @@ +# ConsumerConnection + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | | [optional] [readonly] +**name** | **str** | | [optional] +**icon** | **str** | | [optional] +**logo** | **str** | | [optional] +**website** | **str** | | [optional] [readonly] +**tag_line** | **str** | | [optional] [readonly] +**service_id** | **str** | | [optional] +**unified_api** | **str** | | [optional] +**consumer_id** | **str** | | [optional] +**auth_type** | [**AuthType**](AuthType.md) | | [optional] +**enabled** | **bool** | | [optional] +**settings** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type** | Connection settings. Values will persist to `form_fields` with corresponding id | [optional] +**metadata** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type** | Attach your own consumer specific metadata | [optional] +**created_at** | **str** | | [optional] +**updated_at** | **str, none_type** | | [optional] +**state** | **str** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/ConsumerMetadata.md b/docs/models/ConsumerMetadata.md new file mode 100644 index 0000000000..8eb696bc5d --- /dev/null +++ b/docs/models/ConsumerMetadata.md @@ -0,0 +1,15 @@ +# ConsumerMetadata + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**account_name** | **str** | | [optional] +**user_name** | **str** | | [optional] +**email** | **str** | | [optional] +**image** | **str** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/ConsumerRequestCountsInDateRangeResponse.md b/docs/models/ConsumerRequestCountsInDateRangeResponse.md new file mode 100644 index 0000000000..d4e1dd302b --- /dev/null +++ b/docs/models/ConsumerRequestCountsInDateRangeResponse.md @@ -0,0 +1,14 @@ +# ConsumerRequestCountsInDateRangeResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**data** | [**ConsumerRequestCountsInDateRangeResponseData**](ConsumerRequestCountsInDateRangeResponseData.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/ConsumerRequestCountsInDateRangeResponseData.md b/docs/models/ConsumerRequestCountsInDateRangeResponseData.md new file mode 100644 index 0000000000..d338a9e87d --- /dev/null +++ b/docs/models/ConsumerRequestCountsInDateRangeResponseData.md @@ -0,0 +1,17 @@ +# ConsumerRequestCountsInDateRangeResponseData + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**application_id** | **str** | | [optional] +**consumer_id** | **str** | | [optional] +**start_datetime** | **str** | | [optional] +**end_datetime** | **str** | | [optional] +**aggregated_request_count** | **float** | | [optional] +**request_counts** | [**RequestCountAllocation**](RequestCountAllocation.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/Contact.md b/docs/models/Contact.md new file mode 100644 index 0000000000..0333f42db1 --- /dev/null +++ b/docs/models/Contact.md @@ -0,0 +1,48 @@ +# Contact + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | | +**id** | **str** | | [optional] [readonly] +**owner_id** | **str, none_type** | | [optional] +**type** | **str, none_type** | | [optional] +**company_id** | **str, none_type** | | [optional] +**company_name** | **str, none_type** | | [optional] +**lead_id** | **str, none_type** | | [optional] +**first_name** | **str, none_type** | | [optional] +**middle_name** | **str, none_type** | | [optional] +**last_name** | **str, none_type** | | [optional] +**prefix** | **str, none_type** | | [optional] +**suffix** | **str, none_type** | | [optional] +**title** | **str, none_type** | | [optional] +**department** | **str, none_type** | | [optional] +**language** | **str, none_type** | language code according to ISO 639-1. For the United States - EN | [optional] +**gender** | **str, none_type** | | [optional] +**birthday** | **str, none_type** | | [optional] +**image** | **str, none_type** | | [optional] +**photo_url** | **str, none_type** | | [optional] +**lead_source** | **str, none_type** | | [optional] +**fax** | **str, none_type** | | [optional] +**description** | **str, none_type** | | [optional] +**current_balance** | **float, none_type** | | [optional] +**status** | **str, none_type** | | [optional] +**active** | **bool, none_type** | | [optional] +**websites** | [**[Website]**](Website.md) | | [optional] +**addresses** | [**[Address]**](Address.md) | | [optional] +**social_links** | [**[SocialLink]**](SocialLink.md) | | [optional] +**phone_numbers** | [**[PhoneNumber]**](PhoneNumber.md) | | [optional] +**emails** | [**[Email]**](Email.md) | | [optional] +**email_domain** | **str, none_type** | | [optional] +**custom_fields** | [**[CustomField]**](CustomField.md) | | [optional] +**tags** | [**Tags**](Tags.md) | | [optional] +**first_call_at** | **datetime, none_type** | | [optional] [readonly] +**first_email_at** | **datetime, none_type** | | [optional] [readonly] +**last_activity_at** | **datetime, none_type** | | [optional] [readonly] +**updated_at** | **datetime** | | [optional] [readonly] +**created_at** | **datetime** | | [optional] [readonly] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/ContactsFilter.md b/docs/models/ContactsFilter.md new file mode 100644 index 0000000000..85abe27308 --- /dev/null +++ b/docs/models/ContactsFilter.md @@ -0,0 +1,14 @@ +# ContactsFilter + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Name of the contact to filter on | [optional] +**first_name** | **str** | First name of the contact to filter on | [optional] +**last_name** | **str** | Last name of the contact to filter on | [optional] +**email** | **str** | E-mail of the contact to filter on | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/ContactsSort.md b/docs/models/ContactsSort.md new file mode 100644 index 0000000000..cf48e3f719 --- /dev/null +++ b/docs/models/ContactsSort.md @@ -0,0 +1,12 @@ +# ContactsSort + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**by** | **str** | The field on which to sort the Contacts | [optional] +**direction** | [**SortDirection**](SortDirection.md) | | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/CopyFolderRequest.md b/docs/models/CopyFolderRequest.md new file mode 100644 index 0000000000..eb657ae1e0 --- /dev/null +++ b/docs/models/CopyFolderRequest.md @@ -0,0 +1,13 @@ +# CopyFolderRequest + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**parent_folder_id** | **str** | The parent folder to create the new file within. | +**id** | **str** | | [optional] [readonly] +**name** | **str** | The name of the folder. | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/CreateActivityResponse.md b/docs/models/CreateActivityResponse.md new file mode 100644 index 0000000000..646e8252e3 --- /dev/null +++ b/docs/models/CreateActivityResponse.md @@ -0,0 +1,17 @@ +# CreateActivityResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedId**](UnifiedId.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/CreateApplicantResponse.md b/docs/models/CreateApplicantResponse.md new file mode 100644 index 0000000000..c57e98900a --- /dev/null +++ b/docs/models/CreateApplicantResponse.md @@ -0,0 +1,17 @@ +# CreateApplicantResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedId**](UnifiedId.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/CreateBillResponse.md b/docs/models/CreateBillResponse.md new file mode 100644 index 0000000000..0af7a27306 --- /dev/null +++ b/docs/models/CreateBillResponse.md @@ -0,0 +1,17 @@ +# CreateBillResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedId**](UnifiedId.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/CreateCompanyResponse.md b/docs/models/CreateCompanyResponse.md new file mode 100644 index 0000000000..e499cdc102 --- /dev/null +++ b/docs/models/CreateCompanyResponse.md @@ -0,0 +1,17 @@ +# CreateCompanyResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedId**](UnifiedId.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/CreateConnectionResponse.md b/docs/models/CreateConnectionResponse.md new file mode 100644 index 0000000000..3a45bd72d7 --- /dev/null +++ b/docs/models/CreateConnectionResponse.md @@ -0,0 +1,14 @@ +# CreateConnectionResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**data** | [**Connection**](Connection.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/CreateContactResponse.md b/docs/models/CreateContactResponse.md new file mode 100644 index 0000000000..f58553f04c --- /dev/null +++ b/docs/models/CreateContactResponse.md @@ -0,0 +1,17 @@ +# CreateContactResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedId**](UnifiedId.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/CreateCreditNoteResponse.md b/docs/models/CreateCreditNoteResponse.md new file mode 100644 index 0000000000..7d41674987 --- /dev/null +++ b/docs/models/CreateCreditNoteResponse.md @@ -0,0 +1,17 @@ +# CreateCreditNoteResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedId**](UnifiedId.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/CreateCustomerResponse.md b/docs/models/CreateCustomerResponse.md new file mode 100644 index 0000000000..2a9565e635 --- /dev/null +++ b/docs/models/CreateCustomerResponse.md @@ -0,0 +1,17 @@ +# CreateCustomerResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedId**](UnifiedId.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/CreateCustomerSupportCustomerResponse.md b/docs/models/CreateCustomerSupportCustomerResponse.md new file mode 100644 index 0000000000..8088517673 --- /dev/null +++ b/docs/models/CreateCustomerSupportCustomerResponse.md @@ -0,0 +1,17 @@ +# CreateCustomerSupportCustomerResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedId**](UnifiedId.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/CreateDepartmentResponse.md b/docs/models/CreateDepartmentResponse.md new file mode 100644 index 0000000000..505d16fc60 --- /dev/null +++ b/docs/models/CreateDepartmentResponse.md @@ -0,0 +1,17 @@ +# CreateDepartmentResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedId**](UnifiedId.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/CreateDriveGroupResponse.md b/docs/models/CreateDriveGroupResponse.md new file mode 100644 index 0000000000..d3b3aed34e --- /dev/null +++ b/docs/models/CreateDriveGroupResponse.md @@ -0,0 +1,17 @@ +# CreateDriveGroupResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedId**](UnifiedId.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/CreateDriveResponse.md b/docs/models/CreateDriveResponse.md new file mode 100644 index 0000000000..fc84126cde --- /dev/null +++ b/docs/models/CreateDriveResponse.md @@ -0,0 +1,17 @@ +# CreateDriveResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedId**](UnifiedId.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/CreateEmployeeResponse.md b/docs/models/CreateEmployeeResponse.md new file mode 100644 index 0000000000..e726bf253b --- /dev/null +++ b/docs/models/CreateEmployeeResponse.md @@ -0,0 +1,17 @@ +# CreateEmployeeResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedId**](UnifiedId.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/CreateFileRequest.md b/docs/models/CreateFileRequest.md new file mode 100644 index 0000000000..a4b52bca91 --- /dev/null +++ b/docs/models/CreateFileRequest.md @@ -0,0 +1,14 @@ +# CreateFileRequest + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | The name of the file. | +**parent_folder_id** | **str** | The parent folder to create the new file within. | +**drive_id** | **str** | ID of the drive to upload to. | [optional] +**description** | **str** | Optional description of the file. | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/CreateFileResponse.md b/docs/models/CreateFileResponse.md new file mode 100644 index 0000000000..c2dd0744d2 --- /dev/null +++ b/docs/models/CreateFileResponse.md @@ -0,0 +1,17 @@ +# CreateFileResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedId**](UnifiedId.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/CreateFolderRequest.md b/docs/models/CreateFolderRequest.md new file mode 100644 index 0000000000..dd4726a9aa --- /dev/null +++ b/docs/models/CreateFolderRequest.md @@ -0,0 +1,15 @@ +# CreateFolderRequest + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | The name of the folder. | +**parent_folder_id** | **str** | The parent folder to create the new file within. | +**id** | **str** | | [optional] [readonly] +**description** | **str** | Optional description of the folder. | [optional] +**drive_id** | **str** | ID of the drive to create the folder in. | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/CreateFolderResponse.md b/docs/models/CreateFolderResponse.md new file mode 100644 index 0000000000..7f323bea27 --- /dev/null +++ b/docs/models/CreateFolderResponse.md @@ -0,0 +1,17 @@ +# CreateFolderResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedId**](UnifiedId.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/CreateHrisCompanyResponse.md b/docs/models/CreateHrisCompanyResponse.md new file mode 100644 index 0000000000..2558aa6dc1 --- /dev/null +++ b/docs/models/CreateHrisCompanyResponse.md @@ -0,0 +1,17 @@ +# CreateHrisCompanyResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedId**](UnifiedId.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/CreateInvoiceItemResponse.md b/docs/models/CreateInvoiceItemResponse.md new file mode 100644 index 0000000000..b0e38b0675 --- /dev/null +++ b/docs/models/CreateInvoiceItemResponse.md @@ -0,0 +1,17 @@ +# CreateInvoiceItemResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedId**](UnifiedId.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/CreateInvoiceResponse.md b/docs/models/CreateInvoiceResponse.md new file mode 100644 index 0000000000..dc548d0c5b --- /dev/null +++ b/docs/models/CreateInvoiceResponse.md @@ -0,0 +1,17 @@ +# CreateInvoiceResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**InvoiceResponse**](InvoiceResponse.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/CreateItemResponse.md b/docs/models/CreateItemResponse.md new file mode 100644 index 0000000000..8f99123a2e --- /dev/null +++ b/docs/models/CreateItemResponse.md @@ -0,0 +1,17 @@ +# CreateItemResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedId**](UnifiedId.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/CreateJobResponse.md b/docs/models/CreateJobResponse.md new file mode 100644 index 0000000000..a6e1a6e581 --- /dev/null +++ b/docs/models/CreateJobResponse.md @@ -0,0 +1,17 @@ +# CreateJobResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedId**](UnifiedId.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/CreateLeadResponse.md b/docs/models/CreateLeadResponse.md new file mode 100644 index 0000000000..a453370fa8 --- /dev/null +++ b/docs/models/CreateLeadResponse.md @@ -0,0 +1,17 @@ +# CreateLeadResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedId**](UnifiedId.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/CreateLedgerAccountResponse.md b/docs/models/CreateLedgerAccountResponse.md new file mode 100644 index 0000000000..4948c766ad --- /dev/null +++ b/docs/models/CreateLedgerAccountResponse.md @@ -0,0 +1,17 @@ +# CreateLedgerAccountResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedId**](UnifiedId.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/CreateLocationResponse.md b/docs/models/CreateLocationResponse.md new file mode 100644 index 0000000000..5fac450740 --- /dev/null +++ b/docs/models/CreateLocationResponse.md @@ -0,0 +1,17 @@ +# CreateLocationResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedId**](UnifiedId.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/CreateMerchantResponse.md b/docs/models/CreateMerchantResponse.md new file mode 100644 index 0000000000..c44055a490 --- /dev/null +++ b/docs/models/CreateMerchantResponse.md @@ -0,0 +1,17 @@ +# CreateMerchantResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedId**](UnifiedId.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/CreateMessageResponse.md b/docs/models/CreateMessageResponse.md new file mode 100644 index 0000000000..75b5b38357 --- /dev/null +++ b/docs/models/CreateMessageResponse.md @@ -0,0 +1,17 @@ +# CreateMessageResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedId**](UnifiedId.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/CreateModifierGroupResponse.md b/docs/models/CreateModifierGroupResponse.md new file mode 100644 index 0000000000..2d14b0d530 --- /dev/null +++ b/docs/models/CreateModifierGroupResponse.md @@ -0,0 +1,17 @@ +# CreateModifierGroupResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedId**](UnifiedId.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/CreateModifierResponse.md b/docs/models/CreateModifierResponse.md new file mode 100644 index 0000000000..3debb5ec57 --- /dev/null +++ b/docs/models/CreateModifierResponse.md @@ -0,0 +1,17 @@ +# CreateModifierResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedId**](UnifiedId.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/CreateNoteResponse.md b/docs/models/CreateNoteResponse.md new file mode 100644 index 0000000000..6c9c357a91 --- /dev/null +++ b/docs/models/CreateNoteResponse.md @@ -0,0 +1,17 @@ +# CreateNoteResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedId**](UnifiedId.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/CreateOpportunityResponse.md b/docs/models/CreateOpportunityResponse.md new file mode 100644 index 0000000000..1855736c57 --- /dev/null +++ b/docs/models/CreateOpportunityResponse.md @@ -0,0 +1,17 @@ +# CreateOpportunityResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedId**](UnifiedId.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/CreateOrderResponse.md b/docs/models/CreateOrderResponse.md new file mode 100644 index 0000000000..da9bc15479 --- /dev/null +++ b/docs/models/CreateOrderResponse.md @@ -0,0 +1,17 @@ +# CreateOrderResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedId**](UnifiedId.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/CreateOrderTypeResponse.md b/docs/models/CreateOrderTypeResponse.md new file mode 100644 index 0000000000..37ce687e5e --- /dev/null +++ b/docs/models/CreateOrderTypeResponse.md @@ -0,0 +1,17 @@ +# CreateOrderTypeResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedId**](UnifiedId.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/CreatePaymentResponse.md b/docs/models/CreatePaymentResponse.md new file mode 100644 index 0000000000..2bf0319070 --- /dev/null +++ b/docs/models/CreatePaymentResponse.md @@ -0,0 +1,17 @@ +# CreatePaymentResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedId**](UnifiedId.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/CreatePipelineResponse.md b/docs/models/CreatePipelineResponse.md new file mode 100644 index 0000000000..d9ede2ce01 --- /dev/null +++ b/docs/models/CreatePipelineResponse.md @@ -0,0 +1,17 @@ +# CreatePipelineResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedId**](UnifiedId.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/CreatePosPaymentResponse.md b/docs/models/CreatePosPaymentResponse.md new file mode 100644 index 0000000000..3fb8705885 --- /dev/null +++ b/docs/models/CreatePosPaymentResponse.md @@ -0,0 +1,17 @@ +# CreatePosPaymentResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedId**](UnifiedId.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/CreateSessionResponse.md b/docs/models/CreateSessionResponse.md new file mode 100644 index 0000000000..df3d00194b --- /dev/null +++ b/docs/models/CreateSessionResponse.md @@ -0,0 +1,13 @@ +# CreateSessionResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**data** | [**CreateSessionResponseData**](CreateSessionResponseData.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/CreateSessionResponseData.md b/docs/models/CreateSessionResponseData.md new file mode 100644 index 0000000000..0c68ac04bb --- /dev/null +++ b/docs/models/CreateSessionResponseData.md @@ -0,0 +1,13 @@ +# CreateSessionResponseData + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**session_uri** | **str** | | [readonly] +**session_token** | **str** | | [readonly] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/CreateSharedLinkResponse.md b/docs/models/CreateSharedLinkResponse.md new file mode 100644 index 0000000000..65f0e00faf --- /dev/null +++ b/docs/models/CreateSharedLinkResponse.md @@ -0,0 +1,17 @@ +# CreateSharedLinkResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedId**](UnifiedId.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/CreateSupplierResponse.md b/docs/models/CreateSupplierResponse.md new file mode 100644 index 0000000000..11dbcbf5b7 --- /dev/null +++ b/docs/models/CreateSupplierResponse.md @@ -0,0 +1,17 @@ +# CreateSupplierResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedId**](UnifiedId.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/CreateTaxRateResponse.md b/docs/models/CreateTaxRateResponse.md new file mode 100644 index 0000000000..db4121ab90 --- /dev/null +++ b/docs/models/CreateTaxRateResponse.md @@ -0,0 +1,17 @@ +# CreateTaxRateResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedId**](UnifiedId.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/CreateTenderResponse.md b/docs/models/CreateTenderResponse.md new file mode 100644 index 0000000000..d3be070f5a --- /dev/null +++ b/docs/models/CreateTenderResponse.md @@ -0,0 +1,17 @@ +# CreateTenderResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedId**](UnifiedId.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/CreateTimeOffRequestResponse.md b/docs/models/CreateTimeOffRequestResponse.md new file mode 100644 index 0000000000..c9025b8694 --- /dev/null +++ b/docs/models/CreateTimeOffRequestResponse.md @@ -0,0 +1,17 @@ +# CreateTimeOffRequestResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedId**](UnifiedId.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/CreateUploadSessionRequest.md b/docs/models/CreateUploadSessionRequest.md new file mode 100644 index 0000000000..44146f1a81 --- /dev/null +++ b/docs/models/CreateUploadSessionRequest.md @@ -0,0 +1,14 @@ +# CreateUploadSessionRequest + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | The name of the file. | +**parent_folder_id** | **str** | The parent folder to create the new file within. | +**size** | **int** | The size of the file in bytes | +**drive_id** | **str** | ID of the drive to upload to. | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/CreateUploadSessionResponse.md b/docs/models/CreateUploadSessionResponse.md new file mode 100644 index 0000000000..f3c1a1c88f --- /dev/null +++ b/docs/models/CreateUploadSessionResponse.md @@ -0,0 +1,17 @@ +# CreateUploadSessionResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedId**](UnifiedId.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/CreateUserResponse.md b/docs/models/CreateUserResponse.md new file mode 100644 index 0000000000..6e2b39e224 --- /dev/null +++ b/docs/models/CreateUserResponse.md @@ -0,0 +1,17 @@ +# CreateUserResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedId**](UnifiedId.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/CreateWebhookRequest.md b/docs/models/CreateWebhookRequest.md new file mode 100644 index 0000000000..4e63870d43 --- /dev/null +++ b/docs/models/CreateWebhookRequest.md @@ -0,0 +1,15 @@ +# CreateWebhookRequest + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**unified_api** | [**UnifiedApiId**](UnifiedApiId.md) | | +**status** | [**Status**](Status.md) | | +**delivery_url** | [**DeliveryUrl**](DeliveryUrl.md) | | +**events** | [**[WebhookEventType]**](WebhookEventType.md) | The list of subscribed events for this webhook. [`*`] indicates that all events are enabled. | +**description** | **str, none_type** | | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/CreateWebhookResponse.md b/docs/models/CreateWebhookResponse.md new file mode 100644 index 0000000000..53accad556 --- /dev/null +++ b/docs/models/CreateWebhookResponse.md @@ -0,0 +1,14 @@ +# CreateWebhookResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**data** | [**Webhook**](Webhook.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/CreditNote.md b/docs/models/CreditNote.md new file mode 100644 index 0000000000..bd77998236 --- /dev/null +++ b/docs/models/CreditNote.md @@ -0,0 +1,37 @@ +# CreditNote + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**total_amount** | **float** | Amount of transaction | +**id** | **str** | Unique identifier representing the entity | [optional] [readonly] +**number** | **str, none_type** | Credit note number. | [optional] +**customer** | [**LinkedCustomer**](LinkedCustomer.md) | | [optional] +**currency** | [**Currency**](Currency.md) | | [optional] +**currency_rate** | **float, none_type** | Currency Exchange Rate at the time entity was recorded/generated. | [optional] +**tax_inclusive** | **bool, none_type** | Amounts are including tax | [optional] +**sub_total** | **float, none_type** | Sub-total amount, normally before tax. | [optional] +**total_tax** | **float, none_type** | Total tax amount applied to this invoice. | [optional] +**tax_code** | **str, none_type** | Applicable tax id/code override if tax is not supplied on a line item basis. | [optional] +**balance** | **float, none_type** | The balance reflecting any payments made against the transaction. | [optional] +**remaining_credit** | **float, none_type** | Indicates the total credit amount still available to apply towards the payment. | [optional] +**status** | **str** | Status of payment | [optional] +**reference** | **str, none_type** | Optional reference message ie: Debit remittance detail. | [optional] +**date_issued** | **datetime** | Date credit note issued - YYYY:MM::DDThh:mm:ss.sTZD | [optional] +**date_paid** | **datetime, none_type** | Date credit note paid - YYYY:MM::DDThh:mm:ss.sTZD | [optional] +**type** | **str** | Type of payment | [optional] +**account** | [**LinkedLedgerAccount**](LinkedLedgerAccount.md) | | [optional] +**line_items** | [**[InvoiceLineItem]**](InvoiceLineItem.md) | | [optional] +**allocations** | **[bool, date, datetime, dict, float, int, list, str, none_type]** | | [optional] +**note** | **str, none_type** | Optional note to be associated with the credit note. | [optional] +**row_version** | **str, none_type** | | [optional] +**updated_by** | **str, none_type** | | [optional] [readonly] +**created_by** | **str, none_type** | | [optional] [readonly] +**updated_at** | **datetime** | | [optional] [readonly] +**created_at** | **datetime** | | [optional] [readonly] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/CrmEventType.md b/docs/models/CrmEventType.md new file mode 100644 index 0000000000..6227705a1e --- /dev/null +++ b/docs/models/CrmEventType.md @@ -0,0 +1,11 @@ +# CrmEventType + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **str** | | must be one of ["*", "crm.activity.created", "crm.activity.updated", "crm.activity.deleted", "crm.company.created", "crm.company.updated", "crm.company.deleted", "crm.contact.created", "crm.contact.updated", "crm.contact.deleted", "crm.lead.created", "crm.lead.updated", "crm.lead.deleted", "crm.note.created", "crm.note.updated", "crm.note.deleted", "crm.opportunity.created", "crm.opportunity.updated", "crm.opportunity.deleted", ] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/Currency.md b/docs/models/Currency.md new file mode 100644 index 0000000000..694ec4485c --- /dev/null +++ b/docs/models/Currency.md @@ -0,0 +1,12 @@ +# Currency + +Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **str** | Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). | must be one of ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRC", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", ] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/CustomField.md b/docs/models/CustomField.md new file mode 100644 index 0000000000..d2411ea407 --- /dev/null +++ b/docs/models/CustomField.md @@ -0,0 +1,14 @@ +# CustomField + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | | +**name** | **str** | Name of the custom field. | [optional] +**description** | **str** | More information about the custom field | [optional] +**value** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/CustomerSupportCustomer.md b/docs/models/CustomerSupportCustomer.md new file mode 100644 index 0000000000..c88e9651e2 --- /dev/null +++ b/docs/models/CustomerSupportCustomer.md @@ -0,0 +1,27 @@ +# CustomerSupportCustomer + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | | [optional] [readonly] +**company_name** | **str, none_type** | | [optional] +**first_name** | **str, none_type** | | [optional] +**last_name** | **str, none_type** | | [optional] +**individual** | **bool, none_type** | | [optional] +**addresses** | [**[Address]**](Address.md) | | [optional] +**notes** | **str, none_type** | | [optional] +**phone_numbers** | [**[PhoneNumber]**](PhoneNumber.md) | | [optional] +**emails** | [**[Email]**](Email.md) | | [optional] +**tax_number** | **str, none_type** | | [optional] +**currency** | [**Currency**](Currency.md) | | [optional] +**bank_accounts** | [**BankAccount**](BankAccount.md) | | [optional] +**status** | **str, none_type** | Customer status | [optional] +**updated_by** | **str, none_type** | | [optional] [readonly] +**created_by** | **str, none_type** | | [optional] [readonly] +**updated_at** | **datetime** | | [optional] [readonly] +**created_at** | **datetime** | | [optional] [readonly] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/CustomersFilter.md b/docs/models/CustomersFilter.md new file mode 100644 index 0000000000..9922cd3cd7 --- /dev/null +++ b/docs/models/CustomersFilter.md @@ -0,0 +1,15 @@ +# CustomersFilter + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**company_name** | **str** | Company Name of customer to search for | [optional] +**display_name** | **str** | Display Name of customer to search for | [optional] +**first_name** | **str** | First name of customer to search for | [optional] +**last_name** | **str** | Last name of customer to search for | [optional] +**email** | **str** | Email of customer to search for | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/Deduction.md b/docs/models/Deduction.md new file mode 100644 index 0000000000..def097ee2c --- /dev/null +++ b/docs/models/Deduction.md @@ -0,0 +1,13 @@ +# Deduction + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | The name of the deduction. | [optional] +**amount** | **float** | The amount deducted. | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/DeleteActivityResponse.md b/docs/models/DeleteActivityResponse.md new file mode 100644 index 0000000000..dd39d1ca3b --- /dev/null +++ b/docs/models/DeleteActivityResponse.md @@ -0,0 +1,17 @@ +# DeleteActivityResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedId**](UnifiedId.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/DeleteBillResponse.md b/docs/models/DeleteBillResponse.md new file mode 100644 index 0000000000..3d9764bcde --- /dev/null +++ b/docs/models/DeleteBillResponse.md @@ -0,0 +1,17 @@ +# DeleteBillResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedId**](UnifiedId.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/DeleteCompanyResponse.md b/docs/models/DeleteCompanyResponse.md new file mode 100644 index 0000000000..89146126b6 --- /dev/null +++ b/docs/models/DeleteCompanyResponse.md @@ -0,0 +1,17 @@ +# DeleteCompanyResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedId**](UnifiedId.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/DeleteContactResponse.md b/docs/models/DeleteContactResponse.md new file mode 100644 index 0000000000..182a0c51be --- /dev/null +++ b/docs/models/DeleteContactResponse.md @@ -0,0 +1,17 @@ +# DeleteContactResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedId**](UnifiedId.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/DeleteCreditNoteResponse.md b/docs/models/DeleteCreditNoteResponse.md new file mode 100644 index 0000000000..32717625c4 --- /dev/null +++ b/docs/models/DeleteCreditNoteResponse.md @@ -0,0 +1,17 @@ +# DeleteCreditNoteResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedId**](UnifiedId.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/DeleteCustomerResponse.md b/docs/models/DeleteCustomerResponse.md new file mode 100644 index 0000000000..50a6996596 --- /dev/null +++ b/docs/models/DeleteCustomerResponse.md @@ -0,0 +1,17 @@ +# DeleteCustomerResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedId**](UnifiedId.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/DeleteCustomerSupportCustomerResponse.md b/docs/models/DeleteCustomerSupportCustomerResponse.md new file mode 100644 index 0000000000..e16751fda7 --- /dev/null +++ b/docs/models/DeleteCustomerSupportCustomerResponse.md @@ -0,0 +1,17 @@ +# DeleteCustomerSupportCustomerResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedId**](UnifiedId.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/DeleteDepartmentResponse.md b/docs/models/DeleteDepartmentResponse.md new file mode 100644 index 0000000000..0dff35b096 --- /dev/null +++ b/docs/models/DeleteDepartmentResponse.md @@ -0,0 +1,17 @@ +# DeleteDepartmentResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedId**](UnifiedId.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/DeleteDriveGroupResponse.md b/docs/models/DeleteDriveGroupResponse.md new file mode 100644 index 0000000000..80f9c547a3 --- /dev/null +++ b/docs/models/DeleteDriveGroupResponse.md @@ -0,0 +1,17 @@ +# DeleteDriveGroupResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedId**](UnifiedId.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/DeleteDriveResponse.md b/docs/models/DeleteDriveResponse.md new file mode 100644 index 0000000000..b756fa80fa --- /dev/null +++ b/docs/models/DeleteDriveResponse.md @@ -0,0 +1,17 @@ +# DeleteDriveResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedId**](UnifiedId.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/DeleteEmployeeResponse.md b/docs/models/DeleteEmployeeResponse.md new file mode 100644 index 0000000000..7df698efcf --- /dev/null +++ b/docs/models/DeleteEmployeeResponse.md @@ -0,0 +1,17 @@ +# DeleteEmployeeResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedId**](UnifiedId.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/DeleteFileResponse.md b/docs/models/DeleteFileResponse.md new file mode 100644 index 0000000000..818cf73f24 --- /dev/null +++ b/docs/models/DeleteFileResponse.md @@ -0,0 +1,17 @@ +# DeleteFileResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedId**](UnifiedId.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/DeleteFolderResponse.md b/docs/models/DeleteFolderResponse.md new file mode 100644 index 0000000000..c14a28b360 --- /dev/null +++ b/docs/models/DeleteFolderResponse.md @@ -0,0 +1,17 @@ +# DeleteFolderResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedId**](UnifiedId.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/DeleteHrisCompanyResponse.md b/docs/models/DeleteHrisCompanyResponse.md new file mode 100644 index 0000000000..f12b070706 --- /dev/null +++ b/docs/models/DeleteHrisCompanyResponse.md @@ -0,0 +1,17 @@ +# DeleteHrisCompanyResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedId**](UnifiedId.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/DeleteInvoiceItemResponse.md b/docs/models/DeleteInvoiceItemResponse.md new file mode 100644 index 0000000000..d493ea55c6 --- /dev/null +++ b/docs/models/DeleteInvoiceItemResponse.md @@ -0,0 +1,11 @@ +# DeleteInvoiceItemResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **DeleteTaxRateResponse** | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/DeleteInvoiceResponse.md b/docs/models/DeleteInvoiceResponse.md new file mode 100644 index 0000000000..3ceb2c81c1 --- /dev/null +++ b/docs/models/DeleteInvoiceResponse.md @@ -0,0 +1,17 @@ +# DeleteInvoiceResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**InvoiceResponse**](InvoiceResponse.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/DeleteItemResponse.md b/docs/models/DeleteItemResponse.md new file mode 100644 index 0000000000..a6fcd35311 --- /dev/null +++ b/docs/models/DeleteItemResponse.md @@ -0,0 +1,17 @@ +# DeleteItemResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedId**](UnifiedId.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/DeleteJobResponse.md b/docs/models/DeleteJobResponse.md new file mode 100644 index 0000000000..21307adf7f --- /dev/null +++ b/docs/models/DeleteJobResponse.md @@ -0,0 +1,17 @@ +# DeleteJobResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedId**](UnifiedId.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/DeleteLeadResponse.md b/docs/models/DeleteLeadResponse.md new file mode 100644 index 0000000000..b0c9cf7296 --- /dev/null +++ b/docs/models/DeleteLeadResponse.md @@ -0,0 +1,17 @@ +# DeleteLeadResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedId**](UnifiedId.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/DeleteLedgerAccountResponse.md b/docs/models/DeleteLedgerAccountResponse.md new file mode 100644 index 0000000000..4003cc0e60 --- /dev/null +++ b/docs/models/DeleteLedgerAccountResponse.md @@ -0,0 +1,17 @@ +# DeleteLedgerAccountResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedId**](UnifiedId.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/DeleteLocationResponse.md b/docs/models/DeleteLocationResponse.md new file mode 100644 index 0000000000..be90a03353 --- /dev/null +++ b/docs/models/DeleteLocationResponse.md @@ -0,0 +1,17 @@ +# DeleteLocationResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedId**](UnifiedId.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/DeleteMerchantResponse.md b/docs/models/DeleteMerchantResponse.md new file mode 100644 index 0000000000..9d85455178 --- /dev/null +++ b/docs/models/DeleteMerchantResponse.md @@ -0,0 +1,17 @@ +# DeleteMerchantResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedId**](UnifiedId.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/DeleteMessageResponse.md b/docs/models/DeleteMessageResponse.md new file mode 100644 index 0000000000..e73cf1169d --- /dev/null +++ b/docs/models/DeleteMessageResponse.md @@ -0,0 +1,17 @@ +# DeleteMessageResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedId**](UnifiedId.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/DeleteModifierGroupResponse.md b/docs/models/DeleteModifierGroupResponse.md new file mode 100644 index 0000000000..0d37572802 --- /dev/null +++ b/docs/models/DeleteModifierGroupResponse.md @@ -0,0 +1,17 @@ +# DeleteModifierGroupResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedId**](UnifiedId.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/DeleteModifierResponse.md b/docs/models/DeleteModifierResponse.md new file mode 100644 index 0000000000..5df7768542 --- /dev/null +++ b/docs/models/DeleteModifierResponse.md @@ -0,0 +1,17 @@ +# DeleteModifierResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedId**](UnifiedId.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/DeleteNoteResponse.md b/docs/models/DeleteNoteResponse.md new file mode 100644 index 0000000000..30b1e5d150 --- /dev/null +++ b/docs/models/DeleteNoteResponse.md @@ -0,0 +1,17 @@ +# DeleteNoteResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedId**](UnifiedId.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/DeleteOpportunityResponse.md b/docs/models/DeleteOpportunityResponse.md new file mode 100644 index 0000000000..191affc84f --- /dev/null +++ b/docs/models/DeleteOpportunityResponse.md @@ -0,0 +1,17 @@ +# DeleteOpportunityResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedId**](UnifiedId.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/DeleteOrderResponse.md b/docs/models/DeleteOrderResponse.md new file mode 100644 index 0000000000..f7326fbe07 --- /dev/null +++ b/docs/models/DeleteOrderResponse.md @@ -0,0 +1,17 @@ +# DeleteOrderResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedId**](UnifiedId.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/DeleteOrderTypeResponse.md b/docs/models/DeleteOrderTypeResponse.md new file mode 100644 index 0000000000..bd9afc3100 --- /dev/null +++ b/docs/models/DeleteOrderTypeResponse.md @@ -0,0 +1,17 @@ +# DeleteOrderTypeResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedId**](UnifiedId.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/DeletePaymentResponse.md b/docs/models/DeletePaymentResponse.md new file mode 100644 index 0000000000..424c1636e6 --- /dev/null +++ b/docs/models/DeletePaymentResponse.md @@ -0,0 +1,17 @@ +# DeletePaymentResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedId**](UnifiedId.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/DeletePipelineResponse.md b/docs/models/DeletePipelineResponse.md new file mode 100644 index 0000000000..3ee3ba246b --- /dev/null +++ b/docs/models/DeletePipelineResponse.md @@ -0,0 +1,17 @@ +# DeletePipelineResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedId**](UnifiedId.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/DeletePosPaymentResponse.md b/docs/models/DeletePosPaymentResponse.md new file mode 100644 index 0000000000..f574c9706c --- /dev/null +++ b/docs/models/DeletePosPaymentResponse.md @@ -0,0 +1,17 @@ +# DeletePosPaymentResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedId**](UnifiedId.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/DeleteSharedLinkResponse.md b/docs/models/DeleteSharedLinkResponse.md new file mode 100644 index 0000000000..15cf68120f --- /dev/null +++ b/docs/models/DeleteSharedLinkResponse.md @@ -0,0 +1,17 @@ +# DeleteSharedLinkResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedId**](UnifiedId.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/DeleteSupplierResponse.md b/docs/models/DeleteSupplierResponse.md new file mode 100644 index 0000000000..9297b17335 --- /dev/null +++ b/docs/models/DeleteSupplierResponse.md @@ -0,0 +1,17 @@ +# DeleteSupplierResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedId**](UnifiedId.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/DeleteTaxRateResponse.md b/docs/models/DeleteTaxRateResponse.md new file mode 100644 index 0000000000..dcc6547031 --- /dev/null +++ b/docs/models/DeleteTaxRateResponse.md @@ -0,0 +1,17 @@ +# DeleteTaxRateResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedId**](UnifiedId.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/DeleteTenderResponse.md b/docs/models/DeleteTenderResponse.md new file mode 100644 index 0000000000..c98dd06a93 --- /dev/null +++ b/docs/models/DeleteTenderResponse.md @@ -0,0 +1,17 @@ +# DeleteTenderResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedId**](UnifiedId.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/DeleteTimeOffRequestResponse.md b/docs/models/DeleteTimeOffRequestResponse.md new file mode 100644 index 0000000000..c298fb2cf7 --- /dev/null +++ b/docs/models/DeleteTimeOffRequestResponse.md @@ -0,0 +1,17 @@ +# DeleteTimeOffRequestResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedId**](UnifiedId.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/DeleteUploadSessionResponse.md b/docs/models/DeleteUploadSessionResponse.md new file mode 100644 index 0000000000..b8bc323b6d --- /dev/null +++ b/docs/models/DeleteUploadSessionResponse.md @@ -0,0 +1,17 @@ +# DeleteUploadSessionResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedId**](UnifiedId.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/DeleteUserResponse.md b/docs/models/DeleteUserResponse.md new file mode 100644 index 0000000000..ce06fa096e --- /dev/null +++ b/docs/models/DeleteUserResponse.md @@ -0,0 +1,17 @@ +# DeleteUserResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedId**](UnifiedId.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/DeleteWebhookResponse.md b/docs/models/DeleteWebhookResponse.md new file mode 100644 index 0000000000..0f5ca4b9a2 --- /dev/null +++ b/docs/models/DeleteWebhookResponse.md @@ -0,0 +1,14 @@ +# DeleteWebhookResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**data** | [**Webhook**](Webhook.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/DeliveryUrl.md b/docs/models/DeliveryUrl.md new file mode 100644 index 0000000000..9ec370bb36 --- /dev/null +++ b/docs/models/DeliveryUrl.md @@ -0,0 +1,12 @@ +# DeliveryUrl + +The delivery url of the webhook endpoint. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **str** | The delivery url of the webhook endpoint. | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/Department.md b/docs/models/Department.md new file mode 100644 index 0000000000..13ce5bbd0f --- /dev/null +++ b/docs/models/Department.md @@ -0,0 +1,18 @@ +# Department + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | | [optional] [readonly] +**name** | **str, none_type** | Department name | [optional] +**code** | **str, none_type** | | [optional] +**description** | **str, none_type** | | [optional] +**updated_by** | **str, none_type** | | [optional] [readonly] +**created_by** | **str, none_type** | | [optional] [readonly] +**updated_at** | **datetime** | | [optional] [readonly] +**created_at** | **datetime** | | [optional] [readonly] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/Drive.md b/docs/models/Drive.md new file mode 100644 index 0000000000..4ce3e4e686 --- /dev/null +++ b/docs/models/Drive.md @@ -0,0 +1,17 @@ +# Drive + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | | [readonly] +**name** | **str** | The name of the drive | +**description** | **str, none_type** | | [optional] +**updated_by** | **str, none_type** | | [optional] [readonly] +**created_by** | **str, none_type** | | [optional] [readonly] +**updated_at** | **datetime** | | [optional] [readonly] +**created_at** | **datetime** | | [optional] [readonly] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/DriveGroup.md b/docs/models/DriveGroup.md new file mode 100644 index 0000000000..7a408d0107 --- /dev/null +++ b/docs/models/DriveGroup.md @@ -0,0 +1,18 @@ +# DriveGroup + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | | [readonly] +**name** | **str** | The name of the drive group | +**display_name** | **str** | The display name of the drive group | [optional] +**description** | **str, none_type** | | [optional] +**updated_by** | **str, none_type** | | [optional] [readonly] +**created_by** | **str, none_type** | | [optional] [readonly] +**updated_at** | **datetime** | | [optional] [readonly] +**created_at** | **datetime** | | [optional] [readonly] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/DriveGroupsFilter.md b/docs/models/DriveGroupsFilter.md new file mode 100644 index 0000000000..7ea17a2411 --- /dev/null +++ b/docs/models/DriveGroupsFilter.md @@ -0,0 +1,11 @@ +# DriveGroupsFilter + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**parent_group_id** | **str** | ID of the drive group to filter on | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/DrivesFilter.md b/docs/models/DrivesFilter.md new file mode 100644 index 0000000000..faf6d93389 --- /dev/null +++ b/docs/models/DrivesFilter.md @@ -0,0 +1,11 @@ +# DrivesFilter + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**group_id** | **str** | ID of the drive group to filter on | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/Email.md b/docs/models/Email.md new file mode 100644 index 0000000000..64cf41aaf9 --- /dev/null +++ b/docs/models/Email.md @@ -0,0 +1,13 @@ +# Email + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**email** | **str** | | +**id** | **str** | | [optional] +**type** | **str** | | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/Employee.md b/docs/models/Employee.md new file mode 100644 index 0000000000..3cfa9d4001 --- /dev/null +++ b/docs/models/Employee.md @@ -0,0 +1,70 @@ +# Employee + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | | [readonly] +**first_name** | **str, none_type** | | [optional] +**last_name** | **str, none_type** | | [optional] +**middle_name** | **str, none_type** | | [optional] +**display_name** | **str, none_type** | | [optional] +**preferred_name** | **str, none_type** | | [optional] +**initials** | **str, none_type** | | [optional] +**salutation** | **str, none_type** | | [optional] +**title** | **str, none_type** | | [optional] +**marital_status** | **str, none_type** | | [optional] +**partner** | [**EmployeePartner**](EmployeePartner.md) | | [optional] +**division** | **str, none_type** | The division the user is currently in. | [optional] +**division_id** | **str, none_type** | Unique identifier of the division this employee belongs to. | [optional] +**department** | **str, none_type** | The department the user is currently in. | [optional] +**department_id** | **str, none_type** | Unique identifier of the department ID this employee belongs to. | [optional] +**team** | [**EmployeeTeam**](EmployeeTeam.md) | | [optional] +**company_id** | **str, none_type** | | [optional] +**company_name** | **str, none_type** | | [optional] +**employment_start_date** | **str, none_type** | A Start Date is the date that the employee started working at the company | [optional] +**employment_end_date** | **str, none_type** | A Start Date is the date that the employee ended working at the company | [optional] +**leaving_reason** | **str, none_type** | The reason because the employment ended | [optional] +**employee_number** | **str, none_type** | An Employee Number, Employee ID or Employee Code, is a unique number that has been assigned to each individual staff member within a company. | [optional] +**employment_status** | **str, none_type** | | [optional] +**employment_role** | [**EmployeeEmploymentRole**](EmployeeEmploymentRole.md) | | [optional] +**manager** | [**EmployeeManager**](EmployeeManager.md) | | [optional] +**direct_reports** | **[str], none_type** | | [optional] +**social_security_number** | **str, none_type** | | [optional] +**birthday** | **date, none_type** | | [optional] +**deceased_on** | **date, none_type** | | [optional] +**country_of_birth** | **str, none_type** | country code according to ISO 3166-1 alpha-2. | [optional] +**description** | **str, none_type** | | [optional] +**gender** | [**Gender**](Gender.md) | | [optional] +**pronouns** | **str, none_type** | | [optional] +**preferred_language** | **str, none_type** | language code according to ISO 639-1. For the United States - EN | [optional] +**languages** | **[str, none_type]** | | [optional] +**nationalities** | **[str, none_type]** | | [optional] +**photo_url** | **str, none_type** | | [optional] +**timezone** | **str, none_type** | | [optional] +**source** | **str, none_type** | When the employee is imported as a new hire, this field indicates what system (e.g. the name of the ATS) this employee was imported from. | [optional] +**source_id** | **str, none_type** | Unique identifier of the employee in the system this employee was imported from (e.g. the ID in the ATS). | [optional] +**record_url** | **str, none_type** | | [optional] +**jobs** | [**[EmployeeJobs]**](EmployeeJobs.md) | | [optional] +**compensations** | [**[EmployeeCompensations]**](EmployeeCompensations.md) | | [optional] +**works_remote** | **bool, none_type** | Indicates whether the employee works remote | [optional] +**addresses** | [**[Address]**](Address.md) | | [optional] +**phone_numbers** | [**[PhoneNumber]**](PhoneNumber.md) | | [optional] +**emails** | [**[Email]**](Email.md) | | [optional] +**custom_fields** | [**[CustomField]**](CustomField.md) | | [optional] +**social_links** | [**[ApplicantSocialLinks]**](ApplicantSocialLinks.md) | | [optional] +**tax_code** | **str, none_type** | | [optional] +**tax_id** | **str, none_type** | | [optional] +**dietary_preference** | **str, none_type** | Indicate the employee's dietary preference. | [optional] +**food_allergies** | **[str], none_type** | Indicate the employee's food allergies. | [optional] +**tags** | **[str]** | | [optional] +**row_version** | **str, none_type** | | [optional] +**deleted** | **bool, none_type** | | [optional] +**updated_by** | **str, none_type** | | [optional] [readonly] +**created_by** | **str, none_type** | | [optional] [readonly] +**updated_at** | **datetime** | | [optional] [readonly] +**created_at** | **datetime** | | [optional] [readonly] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/EmployeeCompensations.md b/docs/models/EmployeeCompensations.md new file mode 100644 index 0000000000..6dbb417b47 --- /dev/null +++ b/docs/models/EmployeeCompensations.md @@ -0,0 +1,18 @@ +# EmployeeCompensations + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | | [optional] [readonly] +**job_id** | **str** | The ID of the job to which the compensation belongs. | [optional] [readonly] +**rate** | **float** | The amount paid per payment unit. | [optional] +**payment_unit** | [**PaymentUnit**](PaymentUnit.md) | | [optional] +**currency** | [**Currency**](Currency.md) | | [optional] +**flsa_status** | **str** | The FLSA status for this compensation. | [optional] +**effective_date** | **str** | The effective date for this compensation. | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/EmployeeEmploymentRole.md b/docs/models/EmployeeEmploymentRole.md new file mode 100644 index 0000000000..8c34dd2381 --- /dev/null +++ b/docs/models/EmployeeEmploymentRole.md @@ -0,0 +1,13 @@ +# EmployeeEmploymentRole + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **str, none_type** | | [optional] +**sub_type** | **str, none_type** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/EmployeeJobs.md b/docs/models/EmployeeJobs.md new file mode 100644 index 0000000000..c0c0d633aa --- /dev/null +++ b/docs/models/EmployeeJobs.md @@ -0,0 +1,23 @@ +# EmployeeJobs + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | | [optional] [readonly] +**employee_id** | **str** | | [optional] [readonly] +**title** | **str, none_type** | | [optional] +**role** | **str, none_type** | | [optional] +**start_date** | **date, none_type** | | [optional] +**end_date** | **date, none_type** | | [optional] +**compensation_rate** | **float** | | [optional] +**currency** | [**Currency**](Currency.md) | | [optional] +**payment_unit** | [**PaymentUnit**](PaymentUnit.md) | | [optional] +**hired_at** | **date, none_type** | | [optional] +**is_primary** | **bool, none_type** | Indicates whether this the employee's primary job | [optional] +**location** | [**Address**](Address.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/EmployeeManager.md b/docs/models/EmployeeManager.md new file mode 100644 index 0000000000..7a45f6959b --- /dev/null +++ b/docs/models/EmployeeManager.md @@ -0,0 +1,16 @@ +# EmployeeManager + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | | [optional] [readonly] +**name** | **str, none_type** | | [optional] +**first_name** | **str, none_type** | | [optional] +**last_name** | **str, none_type** | | [optional] +**email** | **str, none_type** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/EmployeePartner.md b/docs/models/EmployeePartner.md new file mode 100644 index 0000000000..0046534625 --- /dev/null +++ b/docs/models/EmployeePartner.md @@ -0,0 +1,19 @@ +# EmployeePartner + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | | [optional] [readonly] +**first_name** | **str, none_type** | | [optional] +**last_name** | **str, none_type** | | [optional] +**middle_name** | **str, none_type** | | [optional] +**gender** | [**Gender**](Gender.md) | | [optional] +**initials** | **str, none_type** | | [optional] +**birthday** | **date, none_type** | | [optional] +**deceased_on** | **date, none_type** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/EmployeePayroll.md b/docs/models/EmployeePayroll.md new file mode 100644 index 0000000000..6d29d021f4 --- /dev/null +++ b/docs/models/EmployeePayroll.md @@ -0,0 +1,13 @@ +# EmployeePayroll + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**employee** | [**Employee**](Employee.md) | | [optional] +**payroll** | [**Payroll**](Payroll.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/EmployeePayrolls.md b/docs/models/EmployeePayrolls.md new file mode 100644 index 0000000000..61bea4a9d9 --- /dev/null +++ b/docs/models/EmployeePayrolls.md @@ -0,0 +1,13 @@ +# EmployeePayrolls + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**employee** | [**Employee**](Employee.md) | | [optional] +**payrolls** | [**[Payroll]**](Payroll.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/EmployeeSchedules.md b/docs/models/EmployeeSchedules.md new file mode 100644 index 0000000000..2ca3fa394d --- /dev/null +++ b/docs/models/EmployeeSchedules.md @@ -0,0 +1,13 @@ +# EmployeeSchedules + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**employee** | [**Employee**](Employee.md) | | [optional] +**schedules** | [**[Schedule]**](Schedule.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/EmployeeTeam.md b/docs/models/EmployeeTeam.md new file mode 100644 index 0000000000..c5135f13de --- /dev/null +++ b/docs/models/EmployeeTeam.md @@ -0,0 +1,14 @@ +# EmployeeTeam + +The team the user is currently in. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str, none_type** | | [optional] +**name** | **str, none_type** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/EmployeesFilter.md b/docs/models/EmployeesFilter.md new file mode 100644 index 0000000000..56026fdbc9 --- /dev/null +++ b/docs/models/EmployeesFilter.md @@ -0,0 +1,18 @@ +# EmployeesFilter + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**company_id** | **str** | Company ID to filter on | [optional] +**email** | **str** | Email to filter on | [optional] +**first_name** | **str** | First Name to filter on | [optional] +**title** | **str** | Job title to filter on | [optional] +**last_name** | **str** | Last Name to filter on | [optional] +**manager_id** | **str** | Manager id to filter on | [optional] +**employment_status** | **str** | Employment status to filter on | [optional] +**employee_number** | **str** | Employee number to filter on | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/Error.md b/docs/models/Error.md new file mode 100644 index 0000000000..6cb6cf4a2f --- /dev/null +++ b/docs/models/Error.md @@ -0,0 +1,14 @@ +# Error + +The error returned if your message status is failed or undelivered. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**code** | **str** | The error_code provides more information about the failure. If the message was successful, this value is null | [optional] [readonly] +**message** | **str** | | [optional] [readonly] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/ExecuteBaseUrl.md b/docs/models/ExecuteBaseUrl.md new file mode 100644 index 0000000000..1c2f39aa28 --- /dev/null +++ b/docs/models/ExecuteBaseUrl.md @@ -0,0 +1,12 @@ +# ExecuteBaseUrl + +The Unify Base URL events from connectors will be sent to after service id is appended. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **str** | The Unify Base URL events from connectors will be sent to after service id is appended. | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/ExecuteWebhookEventRequest.md b/docs/models/ExecuteWebhookEventRequest.md new file mode 100644 index 0000000000..e4fa67ab3b --- /dev/null +++ b/docs/models/ExecuteWebhookEventRequest.md @@ -0,0 +1,11 @@ +# ExecuteWebhookEventRequest + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/ExecuteWebhookEventsRequest.md b/docs/models/ExecuteWebhookEventsRequest.md new file mode 100644 index 0000000000..9908df195b --- /dev/null +++ b/docs/models/ExecuteWebhookEventsRequest.md @@ -0,0 +1,11 @@ +# ExecuteWebhookEventsRequest + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/ExecuteWebhookResponse.md b/docs/models/ExecuteWebhookResponse.md new file mode 100644 index 0000000000..c272cfa9f6 --- /dev/null +++ b/docs/models/ExecuteWebhookResponse.md @@ -0,0 +1,15 @@ +# ExecuteWebhookResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**request_id** | **str** | UUID of the request received | [optional] +**timestamp** | **str** | ISO Datetime webhook event was received | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/FileStorageEventType.md b/docs/models/FileStorageEventType.md new file mode 100644 index 0000000000..aedf343b83 --- /dev/null +++ b/docs/models/FileStorageEventType.md @@ -0,0 +1,11 @@ +# FileStorageEventType + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **str** | | must be one of ["*", "file-storage.file.created", "file-storage.file.updated", "file-storage.file.deleted", ] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/FileType.md b/docs/models/FileType.md new file mode 100644 index 0000000000..58628a6533 --- /dev/null +++ b/docs/models/FileType.md @@ -0,0 +1,12 @@ +# FileType + +The type of resource. Could be file, folder or url + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **str** | The type of resource. Could be file, folder or url | must be one of ["file", "folder", "url", ] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/FilesFilter.md b/docs/models/FilesFilter.md new file mode 100644 index 0000000000..df4d66e0d7 --- /dev/null +++ b/docs/models/FilesFilter.md @@ -0,0 +1,13 @@ +# FilesFilter + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**drive_id** | **str** | ID of the drive to filter on | [optional] +**folder_id** | **str** | ID of the folder to filter on. The root folder has an alias \"root\" | [optional] +**shared** | **bool** | Only return files and folders that are shared | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/FilesSearch.md b/docs/models/FilesSearch.md new file mode 100644 index 0000000000..7bff0ada04 --- /dev/null +++ b/docs/models/FilesSearch.md @@ -0,0 +1,12 @@ +# FilesSearch + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**query** | **str** | The query to search for. May match across multiple fields. | +**drive_id** | **str** | ID of the drive to filter on | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/FilesSort.md b/docs/models/FilesSort.md new file mode 100644 index 0000000000..9ffd191997 --- /dev/null +++ b/docs/models/FilesSort.md @@ -0,0 +1,12 @@ +# FilesSort + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**by** | **str** | The field on which to sort the Files | [optional] +**direction** | [**SortDirection**](SortDirection.md) | | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/Folder.md b/docs/models/Folder.md new file mode 100644 index 0000000000..983f8e3c87 --- /dev/null +++ b/docs/models/Folder.md @@ -0,0 +1,22 @@ +# Folder + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | The name of the folder | +**parent_folders** | [**[LinkedFolder]**](LinkedFolder.md) | The parent folders of the file, starting from the root | +**id** | **str** | | [optional] [readonly] +**description** | **str** | Optional description of the folder | [optional] +**path** | **str** | The full path of the folder (includes the folder name) | [optional] [readonly] +**size** | **int** | The size of the folder in bytes | [optional] [readonly] +**owner** | [**Owner**](Owner.md) | | [optional] +**parent_folders_complete** | **bool** | Whether the list of parent folder is complete. Some connectors only return the direct parent of a folder | [optional] [readonly] +**updated_by** | **str, none_type** | | [optional] [readonly] +**created_by** | **str, none_type** | | [optional] [readonly] +**updated_at** | **datetime** | | [optional] [readonly] +**created_at** | **datetime** | | [optional] [readonly] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/FormField.md b/docs/models/FormField.md new file mode 100644 index 0000000000..5eb84d9156 --- /dev/null +++ b/docs/models/FormField.md @@ -0,0 +1,23 @@ +# FormField + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The unique identifier of the form field. | [optional] +**label** | **str** | The label of the field | [optional] +**placeholder** | **str, none_type** | The placeholder for the form field | [optional] +**description** | **str, none_type** | The description of the form field | [optional] +**type** | **str** | | [optional] +**required** | **bool** | Indicates if the form field is required, which means it must be filled in before the form can be submitted | [optional] +**custom_field** | **bool** | | [optional] +**allow_custom_values** | **bool** | Only applicable to select fields. Allow the user to add a custom value though the option select if the desired value is not in the option select list. | [optional] if omitted the server will use the default value of False +**disabled** | **bool, none_type** | Indicates if the form field is displayed in a “read-only” mode. | [optional] +**hidden** | **bool, none_type** | Indicates if the form field is not displayed but the value that is being stored on the connection. | [optional] +**sensitive** | **bool, none_type** | Indicates if the form field contains sensitive data, which will display the value as a masked input. | [optional] +**options** | [**[FormFieldOption]**](FormFieldOption.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/FormFieldOption.md b/docs/models/FormFieldOption.md new file mode 100644 index 0000000000..0c0b17f007 --- /dev/null +++ b/docs/models/FormFieldOption.md @@ -0,0 +1,15 @@ +# FormFieldOption + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**label** | **str** | | [optional] +**value** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional] +**id** | **str** | | [optional] +**options** | [**[SimpleFormFieldOption]**](SimpleFormFieldOption.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/FormFieldOptionGroup.md b/docs/models/FormFieldOptionGroup.md new file mode 100644 index 0000000000..06d3b5e195 --- /dev/null +++ b/docs/models/FormFieldOptionGroup.md @@ -0,0 +1,14 @@ +# FormFieldOptionGroup + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | | [optional] +**label** | **str** | | [optional] +**options** | [**[SimpleFormFieldOption]**](SimpleFormFieldOption.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/Gender.md b/docs/models/Gender.md new file mode 100644 index 0000000000..6dcde3759a --- /dev/null +++ b/docs/models/Gender.md @@ -0,0 +1,11 @@ +# Gender + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **str** | | must be one of ["male", "female", "unisex", "other", "not_specified", ] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/GetActivitiesResponse.md b/docs/models/GetActivitiesResponse.md new file mode 100644 index 0000000000..965dc74243 --- /dev/null +++ b/docs/models/GetActivitiesResponse.md @@ -0,0 +1,19 @@ +# GetActivitiesResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**[Activity]**](Activity.md) | | +**meta** | [**Meta**](Meta.md) | | [optional] +**links** | [**Links**](Links.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/GetActivityResponse.md b/docs/models/GetActivityResponse.md new file mode 100644 index 0000000000..9360b55d13 --- /dev/null +++ b/docs/models/GetActivityResponse.md @@ -0,0 +1,17 @@ +# GetActivityResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**Activity**](Activity.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/GetApiResourceCoverageResponse.md b/docs/models/GetApiResourceCoverageResponse.md new file mode 100644 index 0000000000..9d440798ff --- /dev/null +++ b/docs/models/GetApiResourceCoverageResponse.md @@ -0,0 +1,16 @@ +# GetApiResourceCoverageResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**data** | [**ApiResourceCoverage**](ApiResourceCoverage.md) | | +**meta** | [**Meta**](Meta.md) | | [optional] +**links** | [**Links**](Links.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/GetApiResourceResponse.md b/docs/models/GetApiResourceResponse.md new file mode 100644 index 0000000000..324e34645f --- /dev/null +++ b/docs/models/GetApiResourceResponse.md @@ -0,0 +1,16 @@ +# GetApiResourceResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**data** | [**ApiResource**](ApiResource.md) | | +**meta** | [**Meta**](Meta.md) | | [optional] +**links** | [**Links**](Links.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/GetApiResponse.md b/docs/models/GetApiResponse.md new file mode 100644 index 0000000000..35dfc00657 --- /dev/null +++ b/docs/models/GetApiResponse.md @@ -0,0 +1,16 @@ +# GetApiResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**data** | [**Api**](Api.md) | | +**meta** | [**Meta**](Meta.md) | | [optional] +**links** | [**Links**](Links.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/GetApisResponse.md b/docs/models/GetApisResponse.md new file mode 100644 index 0000000000..c4b41f4458 --- /dev/null +++ b/docs/models/GetApisResponse.md @@ -0,0 +1,16 @@ +# GetApisResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**data** | [**[Api]**](Api.md) | | +**meta** | [**Meta**](Meta.md) | | [optional] +**links** | [**Links**](Links.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/GetApplicantResponse.md b/docs/models/GetApplicantResponse.md new file mode 100644 index 0000000000..18024bb359 --- /dev/null +++ b/docs/models/GetApplicantResponse.md @@ -0,0 +1,17 @@ +# GetApplicantResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**Applicant**](Applicant.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/GetApplicantsResponse.md b/docs/models/GetApplicantsResponse.md new file mode 100644 index 0000000000..51d8949d90 --- /dev/null +++ b/docs/models/GetApplicantsResponse.md @@ -0,0 +1,19 @@ +# GetApplicantsResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**[Applicant]**](Applicant.md) | | +**meta** | [**Meta**](Meta.md) | | [optional] +**links** | [**Links**](Links.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/GetBalanceSheetResponse.md b/docs/models/GetBalanceSheetResponse.md new file mode 100644 index 0000000000..5d50b58d4f --- /dev/null +++ b/docs/models/GetBalanceSheetResponse.md @@ -0,0 +1,17 @@ +# GetBalanceSheetResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**BalanceSheet**](BalanceSheet.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/GetBillResponse.md b/docs/models/GetBillResponse.md new file mode 100644 index 0000000000..42b91269ac --- /dev/null +++ b/docs/models/GetBillResponse.md @@ -0,0 +1,17 @@ +# GetBillResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**Bill**](Bill.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/GetBillsResponse.md b/docs/models/GetBillsResponse.md new file mode 100644 index 0000000000..e52f8d43ee --- /dev/null +++ b/docs/models/GetBillsResponse.md @@ -0,0 +1,19 @@ +# GetBillsResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**[Bill]**](Bill.md) | | +**meta** | [**Meta**](Meta.md) | | [optional] +**links** | [**Links**](Links.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/GetCompaniesResponse.md b/docs/models/GetCompaniesResponse.md new file mode 100644 index 0000000000..a670d1261d --- /dev/null +++ b/docs/models/GetCompaniesResponse.md @@ -0,0 +1,19 @@ +# GetCompaniesResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**[Company]**](Company.md) | | +**meta** | [**Meta**](Meta.md) | | [optional] +**links** | [**Links**](Links.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/GetCompanyInfoResponse.md b/docs/models/GetCompanyInfoResponse.md new file mode 100644 index 0000000000..12beae4f88 --- /dev/null +++ b/docs/models/GetCompanyInfoResponse.md @@ -0,0 +1,17 @@ +# GetCompanyInfoResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**CompanyInfo**](CompanyInfo.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/GetCompanyResponse.md b/docs/models/GetCompanyResponse.md new file mode 100644 index 0000000000..a5b67c324d --- /dev/null +++ b/docs/models/GetCompanyResponse.md @@ -0,0 +1,17 @@ +# GetCompanyResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**Company**](Company.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/GetConnectionResponse.md b/docs/models/GetConnectionResponse.md new file mode 100644 index 0000000000..72cb0f71d9 --- /dev/null +++ b/docs/models/GetConnectionResponse.md @@ -0,0 +1,14 @@ +# GetConnectionResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**data** | [**Connection**](Connection.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/GetConnectionsResponse.md b/docs/models/GetConnectionsResponse.md new file mode 100644 index 0000000000..5a1c0d6189 --- /dev/null +++ b/docs/models/GetConnectionsResponse.md @@ -0,0 +1,14 @@ +# GetConnectionsResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**data** | [**[Connection]**](Connection.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/GetConnectorResourceResponse.md b/docs/models/GetConnectorResourceResponse.md new file mode 100644 index 0000000000..2a75aaba70 --- /dev/null +++ b/docs/models/GetConnectorResourceResponse.md @@ -0,0 +1,16 @@ +# GetConnectorResourceResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**data** | [**ConnectorResource**](ConnectorResource.md) | | +**meta** | [**Meta**](Meta.md) | | [optional] +**links** | [**Links**](Links.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/GetConnectorResponse.md b/docs/models/GetConnectorResponse.md new file mode 100644 index 0000000000..7cfe565df1 --- /dev/null +++ b/docs/models/GetConnectorResponse.md @@ -0,0 +1,16 @@ +# GetConnectorResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**data** | [**Connector**](Connector.md) | | +**meta** | [**Meta**](Meta.md) | | [optional] +**links** | [**Links**](Links.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/GetConnectorsResponse.md b/docs/models/GetConnectorsResponse.md new file mode 100644 index 0000000000..68a2474b92 --- /dev/null +++ b/docs/models/GetConnectorsResponse.md @@ -0,0 +1,16 @@ +# GetConnectorsResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**data** | [**[Connector]**](Connector.md) | | +**meta** | [**Meta**](Meta.md) | | [optional] +**links** | [**Links**](Links.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/GetConsumerResponse.md b/docs/models/GetConsumerResponse.md new file mode 100644 index 0000000000..c09e78e8cf --- /dev/null +++ b/docs/models/GetConsumerResponse.md @@ -0,0 +1,14 @@ +# GetConsumerResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**data** | [**Consumer**](Consumer.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/GetConsumersResponse.md b/docs/models/GetConsumersResponse.md new file mode 100644 index 0000000000..627d967004 --- /dev/null +++ b/docs/models/GetConsumersResponse.md @@ -0,0 +1,16 @@ +# GetConsumersResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**data** | [**[GetConsumersResponseData]**](GetConsumersResponseData.md) | | +**meta** | [**Meta**](Meta.md) | | [optional] +**links** | [**Links**](Links.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/GetConsumersResponseData.md b/docs/models/GetConsumersResponseData.md new file mode 100644 index 0000000000..e849a5785f --- /dev/null +++ b/docs/models/GetConsumersResponseData.md @@ -0,0 +1,20 @@ +# GetConsumersResponseData + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**consumer_id** | **str** | | [optional] +**application_id** | **str** | | [optional] +**metadata** | [**ConsumerMetadata**](ConsumerMetadata.md) | | [optional] +**aggregated_request_count** | **float** | | [optional] +**request_counts** | [**RequestCountAllocation**](RequestCountAllocation.md) | | [optional] +**created** | **str** | | [optional] +**modified** | **str** | | [optional] +**request_count_updated** | **str** | | [optional] +**services** | **[str]** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/GetContactResponse.md b/docs/models/GetContactResponse.md new file mode 100644 index 0000000000..c543cc364e --- /dev/null +++ b/docs/models/GetContactResponse.md @@ -0,0 +1,17 @@ +# GetContactResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**Contact**](Contact.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/GetContactsResponse.md b/docs/models/GetContactsResponse.md new file mode 100644 index 0000000000..56868648a2 --- /dev/null +++ b/docs/models/GetContactsResponse.md @@ -0,0 +1,19 @@ +# GetContactsResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**[Contact]**](Contact.md) | | +**meta** | [**Meta**](Meta.md) | | [optional] +**links** | [**Links**](Links.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/GetCreditNoteResponse.md b/docs/models/GetCreditNoteResponse.md new file mode 100644 index 0000000000..f5d1705893 --- /dev/null +++ b/docs/models/GetCreditNoteResponse.md @@ -0,0 +1,17 @@ +# GetCreditNoteResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**CreditNote**](CreditNote.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/GetCreditNotesResponse.md b/docs/models/GetCreditNotesResponse.md new file mode 100644 index 0000000000..3f39ecf525 --- /dev/null +++ b/docs/models/GetCreditNotesResponse.md @@ -0,0 +1,19 @@ +# GetCreditNotesResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**[CreditNote]**](CreditNote.md) | | +**meta** | [**Meta**](Meta.md) | | [optional] +**links** | [**Links**](Links.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/GetCustomerResponse.md b/docs/models/GetCustomerResponse.md new file mode 100644 index 0000000000..2bfdfe9cc2 --- /dev/null +++ b/docs/models/GetCustomerResponse.md @@ -0,0 +1,17 @@ +# GetCustomerResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**AccountingCustomer**](AccountingCustomer.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/GetCustomerSupportCustomerResponse.md b/docs/models/GetCustomerSupportCustomerResponse.md new file mode 100644 index 0000000000..48f66f6d89 --- /dev/null +++ b/docs/models/GetCustomerSupportCustomerResponse.md @@ -0,0 +1,17 @@ +# GetCustomerSupportCustomerResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**CustomerSupportCustomer**](CustomerSupportCustomer.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/GetCustomerSupportCustomersResponse.md b/docs/models/GetCustomerSupportCustomersResponse.md new file mode 100644 index 0000000000..6b060bdb5c --- /dev/null +++ b/docs/models/GetCustomerSupportCustomersResponse.md @@ -0,0 +1,19 @@ +# GetCustomerSupportCustomersResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**[CustomerSupportCustomer]**](CustomerSupportCustomer.md) | | +**meta** | [**Meta**](Meta.md) | | [optional] +**links** | [**Links**](Links.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/GetCustomersResponse.md b/docs/models/GetCustomersResponse.md new file mode 100644 index 0000000000..e334d90b4d --- /dev/null +++ b/docs/models/GetCustomersResponse.md @@ -0,0 +1,19 @@ +# GetCustomersResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**[AccountingCustomer]**](AccountingCustomer.md) | | +**meta** | [**Meta**](Meta.md) | | [optional] +**links** | [**Links**](Links.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/GetDepartmentResponse.md b/docs/models/GetDepartmentResponse.md new file mode 100644 index 0000000000..eeb4a7735d --- /dev/null +++ b/docs/models/GetDepartmentResponse.md @@ -0,0 +1,17 @@ +# GetDepartmentResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**Department**](Department.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/GetDepartmentsResponse.md b/docs/models/GetDepartmentsResponse.md new file mode 100644 index 0000000000..614ade9073 --- /dev/null +++ b/docs/models/GetDepartmentsResponse.md @@ -0,0 +1,19 @@ +# GetDepartmentsResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**[Department]**](Department.md) | | +**meta** | [**Meta**](Meta.md) | | [optional] +**links** | [**Links**](Links.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/GetDriveGroupResponse.md b/docs/models/GetDriveGroupResponse.md new file mode 100644 index 0000000000..ad9f603995 --- /dev/null +++ b/docs/models/GetDriveGroupResponse.md @@ -0,0 +1,17 @@ +# GetDriveGroupResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**DriveGroup**](DriveGroup.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/GetDriveGroupsResponse.md b/docs/models/GetDriveGroupsResponse.md new file mode 100644 index 0000000000..41b078a942 --- /dev/null +++ b/docs/models/GetDriveGroupsResponse.md @@ -0,0 +1,19 @@ +# GetDriveGroupsResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**[DriveGroup]**](DriveGroup.md) | | +**meta** | [**Meta**](Meta.md) | | [optional] +**links** | [**Links**](Links.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/GetDriveResponse.md b/docs/models/GetDriveResponse.md new file mode 100644 index 0000000000..8d89b2461a --- /dev/null +++ b/docs/models/GetDriveResponse.md @@ -0,0 +1,17 @@ +# GetDriveResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**Drive**](Drive.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/GetDrivesResponse.md b/docs/models/GetDrivesResponse.md new file mode 100644 index 0000000000..dad6206075 --- /dev/null +++ b/docs/models/GetDrivesResponse.md @@ -0,0 +1,19 @@ +# GetDrivesResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**[Drive]**](Drive.md) | | +**meta** | [**Meta**](Meta.md) | | [optional] +**links** | [**Links**](Links.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/GetEmployeePayrollResponse.md b/docs/models/GetEmployeePayrollResponse.md new file mode 100644 index 0000000000..eb3ff874eb --- /dev/null +++ b/docs/models/GetEmployeePayrollResponse.md @@ -0,0 +1,17 @@ +# GetEmployeePayrollResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**EmployeePayroll**](EmployeePayroll.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/GetEmployeePayrollsResponse.md b/docs/models/GetEmployeePayrollsResponse.md new file mode 100644 index 0000000000..9a22976743 --- /dev/null +++ b/docs/models/GetEmployeePayrollsResponse.md @@ -0,0 +1,17 @@ +# GetEmployeePayrollsResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**EmployeePayrolls**](EmployeePayrolls.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/GetEmployeeResponse.md b/docs/models/GetEmployeeResponse.md new file mode 100644 index 0000000000..22b3185609 --- /dev/null +++ b/docs/models/GetEmployeeResponse.md @@ -0,0 +1,17 @@ +# GetEmployeeResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**Employee**](Employee.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/GetEmployeeSchedulesResponse.md b/docs/models/GetEmployeeSchedulesResponse.md new file mode 100644 index 0000000000..96fd115097 --- /dev/null +++ b/docs/models/GetEmployeeSchedulesResponse.md @@ -0,0 +1,17 @@ +# GetEmployeeSchedulesResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**EmployeeSchedules**](EmployeeSchedules.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/GetEmployeesResponse.md b/docs/models/GetEmployeesResponse.md new file mode 100644 index 0000000000..c3ee12b22e --- /dev/null +++ b/docs/models/GetEmployeesResponse.md @@ -0,0 +1,19 @@ +# GetEmployeesResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**[Employee]**](Employee.md) | | +**meta** | [**Meta**](Meta.md) | | [optional] +**links** | [**Links**](Links.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/GetFileResponse.md b/docs/models/GetFileResponse.md new file mode 100644 index 0000000000..1156bd98e3 --- /dev/null +++ b/docs/models/GetFileResponse.md @@ -0,0 +1,17 @@ +# GetFileResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedFile**](UnifiedFile.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/GetFilesResponse.md b/docs/models/GetFilesResponse.md new file mode 100644 index 0000000000..67126f9724 --- /dev/null +++ b/docs/models/GetFilesResponse.md @@ -0,0 +1,19 @@ +# GetFilesResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**[UnifiedFile]**](UnifiedFile.md) | | +**meta** | [**Meta**](Meta.md) | | [optional] +**links** | [**Links**](Links.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/GetFolderResponse.md b/docs/models/GetFolderResponse.md new file mode 100644 index 0000000000..8b9c69ecda --- /dev/null +++ b/docs/models/GetFolderResponse.md @@ -0,0 +1,17 @@ +# GetFolderResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**Folder**](Folder.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/GetFoldersResponse.md b/docs/models/GetFoldersResponse.md new file mode 100644 index 0000000000..9af8dfbc02 --- /dev/null +++ b/docs/models/GetFoldersResponse.md @@ -0,0 +1,19 @@ +# GetFoldersResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**[Folder]**](Folder.md) | | +**meta** | [**Meta**](Meta.md) | | [optional] +**links** | [**Links**](Links.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/GetHrisCompaniesResponse.md b/docs/models/GetHrisCompaniesResponse.md new file mode 100644 index 0000000000..32fda5f963 --- /dev/null +++ b/docs/models/GetHrisCompaniesResponse.md @@ -0,0 +1,19 @@ +# GetHrisCompaniesResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**[HrisCompany]**](HrisCompany.md) | | +**meta** | [**Meta**](Meta.md) | | [optional] +**links** | [**Links**](Links.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/GetHrisCompanyResponse.md b/docs/models/GetHrisCompanyResponse.md new file mode 100644 index 0000000000..410fd7734f --- /dev/null +++ b/docs/models/GetHrisCompanyResponse.md @@ -0,0 +1,17 @@ +# GetHrisCompanyResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**HrisCompany**](HrisCompany.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/GetHrisJobResponse.md b/docs/models/GetHrisJobResponse.md new file mode 100644 index 0000000000..59d964f6db --- /dev/null +++ b/docs/models/GetHrisJobResponse.md @@ -0,0 +1,17 @@ +# GetHrisJobResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**HrisJob**](HrisJob.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/GetHrisJobsResponse.md b/docs/models/GetHrisJobsResponse.md new file mode 100644 index 0000000000..68bf32ad52 --- /dev/null +++ b/docs/models/GetHrisJobsResponse.md @@ -0,0 +1,17 @@ +# GetHrisJobsResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**HrisJobs**](HrisJobs.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/GetInvoiceItemResponse.md b/docs/models/GetInvoiceItemResponse.md new file mode 100644 index 0000000000..4ff5b2b893 --- /dev/null +++ b/docs/models/GetInvoiceItemResponse.md @@ -0,0 +1,17 @@ +# GetInvoiceItemResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**InvoiceItem**](InvoiceItem.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/GetInvoiceItemsResponse.md b/docs/models/GetInvoiceItemsResponse.md new file mode 100644 index 0000000000..8af825bc90 --- /dev/null +++ b/docs/models/GetInvoiceItemsResponse.md @@ -0,0 +1,19 @@ +# GetInvoiceItemsResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**[InvoiceItem]**](InvoiceItem.md) | | +**meta** | [**Meta**](Meta.md) | | [optional] +**links** | [**Links**](Links.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/GetInvoiceResponse.md b/docs/models/GetInvoiceResponse.md new file mode 100644 index 0000000000..e8942df71f --- /dev/null +++ b/docs/models/GetInvoiceResponse.md @@ -0,0 +1,17 @@ +# GetInvoiceResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**Invoice**](Invoice.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/GetInvoicesResponse.md b/docs/models/GetInvoicesResponse.md new file mode 100644 index 0000000000..977eaeb33c --- /dev/null +++ b/docs/models/GetInvoicesResponse.md @@ -0,0 +1,19 @@ +# GetInvoicesResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**[Invoice]**](Invoice.md) | | +**meta** | [**Meta**](Meta.md) | | [optional] +**links** | [**Links**](Links.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/GetItemResponse.md b/docs/models/GetItemResponse.md new file mode 100644 index 0000000000..16a6de3068 --- /dev/null +++ b/docs/models/GetItemResponse.md @@ -0,0 +1,17 @@ +# GetItemResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**Item**](Item.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/GetItemsResponse.md b/docs/models/GetItemsResponse.md new file mode 100644 index 0000000000..ee05d06346 --- /dev/null +++ b/docs/models/GetItemsResponse.md @@ -0,0 +1,19 @@ +# GetItemsResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**[Item]**](Item.md) | | +**meta** | [**Meta**](Meta.md) | | [optional] +**links** | [**Links**](Links.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/GetJobResponse.md b/docs/models/GetJobResponse.md new file mode 100644 index 0000000000..a9814de4d9 --- /dev/null +++ b/docs/models/GetJobResponse.md @@ -0,0 +1,17 @@ +# GetJobResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**Job**](Job.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/GetJobsResponse.md b/docs/models/GetJobsResponse.md new file mode 100644 index 0000000000..e3424f2b79 --- /dev/null +++ b/docs/models/GetJobsResponse.md @@ -0,0 +1,19 @@ +# GetJobsResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**[Job]**](Job.md) | | +**meta** | [**Meta**](Meta.md) | | [optional] +**links** | [**Links**](Links.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/GetLeadResponse.md b/docs/models/GetLeadResponse.md new file mode 100644 index 0000000000..afa5506ec1 --- /dev/null +++ b/docs/models/GetLeadResponse.md @@ -0,0 +1,17 @@ +# GetLeadResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**Lead**](Lead.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/GetLeadsResponse.md b/docs/models/GetLeadsResponse.md new file mode 100644 index 0000000000..ba0cc29248 --- /dev/null +++ b/docs/models/GetLeadsResponse.md @@ -0,0 +1,19 @@ +# GetLeadsResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**[Lead]**](Lead.md) | | +**meta** | [**Meta**](Meta.md) | | [optional] +**links** | [**Links**](Links.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/GetLedgerAccountResponse.md b/docs/models/GetLedgerAccountResponse.md new file mode 100644 index 0000000000..0c65e30738 --- /dev/null +++ b/docs/models/GetLedgerAccountResponse.md @@ -0,0 +1,17 @@ +# GetLedgerAccountResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**LedgerAccount**](LedgerAccount.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/GetLedgerAccountsResponse.md b/docs/models/GetLedgerAccountsResponse.md new file mode 100644 index 0000000000..e5e3884929 --- /dev/null +++ b/docs/models/GetLedgerAccountsResponse.md @@ -0,0 +1,19 @@ +# GetLedgerAccountsResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**[LedgerAccount]**](LedgerAccount.md) | | +**meta** | [**Meta**](Meta.md) | | [optional] +**links** | [**Links**](Links.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/GetLocationResponse.md b/docs/models/GetLocationResponse.md new file mode 100644 index 0000000000..6ad5e82ddf --- /dev/null +++ b/docs/models/GetLocationResponse.md @@ -0,0 +1,17 @@ +# GetLocationResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**Location**](Location.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/GetLocationsResponse.md b/docs/models/GetLocationsResponse.md new file mode 100644 index 0000000000..124d08ee0f --- /dev/null +++ b/docs/models/GetLocationsResponse.md @@ -0,0 +1,19 @@ +# GetLocationsResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**[Location]**](Location.md) | | +**meta** | [**Meta**](Meta.md) | | [optional] +**links** | [**Links**](Links.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/GetLogsResponse.md b/docs/models/GetLogsResponse.md new file mode 100644 index 0000000000..893d68b911 --- /dev/null +++ b/docs/models/GetLogsResponse.md @@ -0,0 +1,16 @@ +# GetLogsResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**data** | [**[Log]**](Log.md) | | +**meta** | [**Meta**](Meta.md) | | [optional] +**links** | [**Links**](Links.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/GetMerchantResponse.md b/docs/models/GetMerchantResponse.md new file mode 100644 index 0000000000..a8c335f681 --- /dev/null +++ b/docs/models/GetMerchantResponse.md @@ -0,0 +1,17 @@ +# GetMerchantResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**Merchant**](Merchant.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/GetMerchantsResponse.md b/docs/models/GetMerchantsResponse.md new file mode 100644 index 0000000000..2f8ecbe257 --- /dev/null +++ b/docs/models/GetMerchantsResponse.md @@ -0,0 +1,19 @@ +# GetMerchantsResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**[Merchant]**](Merchant.md) | | +**meta** | [**Meta**](Meta.md) | | [optional] +**links** | [**Links**](Links.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/GetMessageResponse.md b/docs/models/GetMessageResponse.md new file mode 100644 index 0000000000..4545cc5632 --- /dev/null +++ b/docs/models/GetMessageResponse.md @@ -0,0 +1,17 @@ +# GetMessageResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**Message**](Message.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/GetMessagesResponse.md b/docs/models/GetMessagesResponse.md new file mode 100644 index 0000000000..6d12686def --- /dev/null +++ b/docs/models/GetMessagesResponse.md @@ -0,0 +1,19 @@ +# GetMessagesResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**[Message]**](Message.md) | | +**meta** | [**Meta**](Meta.md) | | [optional] +**links** | [**Links**](Links.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/GetModifierGroupResponse.md b/docs/models/GetModifierGroupResponse.md new file mode 100644 index 0000000000..3bb83e64aa --- /dev/null +++ b/docs/models/GetModifierGroupResponse.md @@ -0,0 +1,17 @@ +# GetModifierGroupResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**ModifierGroup**](ModifierGroup.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/GetModifierGroupsResponse.md b/docs/models/GetModifierGroupsResponse.md new file mode 100644 index 0000000000..e56c864aa0 --- /dev/null +++ b/docs/models/GetModifierGroupsResponse.md @@ -0,0 +1,19 @@ +# GetModifierGroupsResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**[ModifierGroup]**](ModifierGroup.md) | | +**meta** | [**Meta**](Meta.md) | | [optional] +**links** | [**Links**](Links.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/GetModifierResponse.md b/docs/models/GetModifierResponse.md new file mode 100644 index 0000000000..f9687232ba --- /dev/null +++ b/docs/models/GetModifierResponse.md @@ -0,0 +1,17 @@ +# GetModifierResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**Modifier**](Modifier.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/GetModifiersResponse.md b/docs/models/GetModifiersResponse.md new file mode 100644 index 0000000000..79889e769d --- /dev/null +++ b/docs/models/GetModifiersResponse.md @@ -0,0 +1,19 @@ +# GetModifiersResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**[Modifier]**](Modifier.md) | | +**meta** | [**Meta**](Meta.md) | | [optional] +**links** | [**Links**](Links.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/GetNoteResponse.md b/docs/models/GetNoteResponse.md new file mode 100644 index 0000000000..4a0216b744 --- /dev/null +++ b/docs/models/GetNoteResponse.md @@ -0,0 +1,17 @@ +# GetNoteResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**Note**](Note.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/GetNotesResponse.md b/docs/models/GetNotesResponse.md new file mode 100644 index 0000000000..612abc16d6 --- /dev/null +++ b/docs/models/GetNotesResponse.md @@ -0,0 +1,19 @@ +# GetNotesResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**[Note]**](Note.md) | | +**meta** | [**Meta**](Meta.md) | | [optional] +**links** | [**Links**](Links.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/GetOpportunitiesResponse.md b/docs/models/GetOpportunitiesResponse.md new file mode 100644 index 0000000000..8d21702db6 --- /dev/null +++ b/docs/models/GetOpportunitiesResponse.md @@ -0,0 +1,19 @@ +# GetOpportunitiesResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**[Opportunity]**](Opportunity.md) | | +**meta** | [**Meta**](Meta.md) | | [optional] +**links** | [**Links**](Links.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/GetOpportunityResponse.md b/docs/models/GetOpportunityResponse.md new file mode 100644 index 0000000000..bae02773b6 --- /dev/null +++ b/docs/models/GetOpportunityResponse.md @@ -0,0 +1,17 @@ +# GetOpportunityResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**Opportunity**](Opportunity.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/GetOrderResponse.md b/docs/models/GetOrderResponse.md new file mode 100644 index 0000000000..d7985a1ab9 --- /dev/null +++ b/docs/models/GetOrderResponse.md @@ -0,0 +1,17 @@ +# GetOrderResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**Order**](Order.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/GetOrderTypeResponse.md b/docs/models/GetOrderTypeResponse.md new file mode 100644 index 0000000000..9811056c7f --- /dev/null +++ b/docs/models/GetOrderTypeResponse.md @@ -0,0 +1,17 @@ +# GetOrderTypeResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**OrderType**](OrderType.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/GetOrderTypesResponse.md b/docs/models/GetOrderTypesResponse.md new file mode 100644 index 0000000000..b294700c51 --- /dev/null +++ b/docs/models/GetOrderTypesResponse.md @@ -0,0 +1,19 @@ +# GetOrderTypesResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**[OrderType]**](OrderType.md) | | +**meta** | [**Meta**](Meta.md) | | [optional] +**links** | [**Links**](Links.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/GetOrdersResponse.md b/docs/models/GetOrdersResponse.md new file mode 100644 index 0000000000..cf194167bc --- /dev/null +++ b/docs/models/GetOrdersResponse.md @@ -0,0 +1,19 @@ +# GetOrdersResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**[Order]**](Order.md) | | +**meta** | [**Meta**](Meta.md) | | [optional] +**links** | [**Links**](Links.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/GetPaymentResponse.md b/docs/models/GetPaymentResponse.md new file mode 100644 index 0000000000..cd57a3e8b9 --- /dev/null +++ b/docs/models/GetPaymentResponse.md @@ -0,0 +1,17 @@ +# GetPaymentResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**Payment**](Payment.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/GetPaymentsResponse.md b/docs/models/GetPaymentsResponse.md new file mode 100644 index 0000000000..f9ad831705 --- /dev/null +++ b/docs/models/GetPaymentsResponse.md @@ -0,0 +1,19 @@ +# GetPaymentsResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**[Payment]**](Payment.md) | | +**meta** | [**Meta**](Meta.md) | | [optional] +**links** | [**Links**](Links.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/GetPayrollResponse.md b/docs/models/GetPayrollResponse.md new file mode 100644 index 0000000000..c2a60f18f3 --- /dev/null +++ b/docs/models/GetPayrollResponse.md @@ -0,0 +1,17 @@ +# GetPayrollResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**Payroll**](Payroll.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/GetPayrollsResponse.md b/docs/models/GetPayrollsResponse.md new file mode 100644 index 0000000000..c56b53a5e3 --- /dev/null +++ b/docs/models/GetPayrollsResponse.md @@ -0,0 +1,17 @@ +# GetPayrollsResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**[Payroll]**](Payroll.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/GetPipelineResponse.md b/docs/models/GetPipelineResponse.md new file mode 100644 index 0000000000..0ea05558fc --- /dev/null +++ b/docs/models/GetPipelineResponse.md @@ -0,0 +1,17 @@ +# GetPipelineResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**Pipeline**](Pipeline.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/GetPipelinesResponse.md b/docs/models/GetPipelinesResponse.md new file mode 100644 index 0000000000..d6f6053d82 --- /dev/null +++ b/docs/models/GetPipelinesResponse.md @@ -0,0 +1,19 @@ +# GetPipelinesResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**[Pipeline]**](Pipeline.md) | | +**meta** | [**Meta**](Meta.md) | | [optional] +**links** | [**Links**](Links.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/GetPosPaymentResponse.md b/docs/models/GetPosPaymentResponse.md new file mode 100644 index 0000000000..7bf664d445 --- /dev/null +++ b/docs/models/GetPosPaymentResponse.md @@ -0,0 +1,17 @@ +# GetPosPaymentResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**PosPayment**](PosPayment.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/GetPosPaymentsResponse.md b/docs/models/GetPosPaymentsResponse.md new file mode 100644 index 0000000000..d68a7a75cc --- /dev/null +++ b/docs/models/GetPosPaymentsResponse.md @@ -0,0 +1,19 @@ +# GetPosPaymentsResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**[PosPayment]**](PosPayment.md) | | +**meta** | [**Meta**](Meta.md) | | [optional] +**links** | [**Links**](Links.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/GetProfitAndLossResponse.md b/docs/models/GetProfitAndLossResponse.md new file mode 100644 index 0000000000..cc3321a80e --- /dev/null +++ b/docs/models/GetProfitAndLossResponse.md @@ -0,0 +1,17 @@ +# GetProfitAndLossResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**ProfitAndLoss**](ProfitAndLoss.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/GetSharedLinkResponse.md b/docs/models/GetSharedLinkResponse.md new file mode 100644 index 0000000000..a0cb90f776 --- /dev/null +++ b/docs/models/GetSharedLinkResponse.md @@ -0,0 +1,17 @@ +# GetSharedLinkResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**SharedLink**](SharedLink.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/GetSharedLinksResponse.md b/docs/models/GetSharedLinksResponse.md new file mode 100644 index 0000000000..e3e3c16e41 --- /dev/null +++ b/docs/models/GetSharedLinksResponse.md @@ -0,0 +1,19 @@ +# GetSharedLinksResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**[SharedLink]**](SharedLink.md) | | +**meta** | [**Meta**](Meta.md) | | [optional] +**links** | [**Links**](Links.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/GetSupplierResponse.md b/docs/models/GetSupplierResponse.md new file mode 100644 index 0000000000..7081f82079 --- /dev/null +++ b/docs/models/GetSupplierResponse.md @@ -0,0 +1,17 @@ +# GetSupplierResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**Supplier**](Supplier.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/GetSuppliersResponse.md b/docs/models/GetSuppliersResponse.md new file mode 100644 index 0000000000..89af320d3d --- /dev/null +++ b/docs/models/GetSuppliersResponse.md @@ -0,0 +1,19 @@ +# GetSuppliersResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**[Supplier]**](Supplier.md) | | +**meta** | [**Meta**](Meta.md) | | [optional] +**links** | [**Links**](Links.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/GetTaxRateResponse.md b/docs/models/GetTaxRateResponse.md new file mode 100644 index 0000000000..00a76efb34 --- /dev/null +++ b/docs/models/GetTaxRateResponse.md @@ -0,0 +1,17 @@ +# GetTaxRateResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**TaxRate**](TaxRate.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/GetTaxRatesResponse.md b/docs/models/GetTaxRatesResponse.md new file mode 100644 index 0000000000..03c2f07959 --- /dev/null +++ b/docs/models/GetTaxRatesResponse.md @@ -0,0 +1,19 @@ +# GetTaxRatesResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**[TaxRate]**](TaxRate.md) | | +**meta** | [**Meta**](Meta.md) | | [optional] +**links** | [**Links**](Links.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/GetTenderResponse.md b/docs/models/GetTenderResponse.md new file mode 100644 index 0000000000..295679eefb --- /dev/null +++ b/docs/models/GetTenderResponse.md @@ -0,0 +1,17 @@ +# GetTenderResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**Tender**](Tender.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/GetTendersResponse.md b/docs/models/GetTendersResponse.md new file mode 100644 index 0000000000..a23944eb48 --- /dev/null +++ b/docs/models/GetTendersResponse.md @@ -0,0 +1,19 @@ +# GetTendersResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**[Tender]**](Tender.md) | | +**meta** | [**Meta**](Meta.md) | | [optional] +**links** | [**Links**](Links.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/GetTimeOffRequestResponse.md b/docs/models/GetTimeOffRequestResponse.md new file mode 100644 index 0000000000..d943141940 --- /dev/null +++ b/docs/models/GetTimeOffRequestResponse.md @@ -0,0 +1,17 @@ +# GetTimeOffRequestResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**TimeOffRequest**](TimeOffRequest.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/GetTimeOffRequestsResponse.md b/docs/models/GetTimeOffRequestsResponse.md new file mode 100644 index 0000000000..d057401563 --- /dev/null +++ b/docs/models/GetTimeOffRequestsResponse.md @@ -0,0 +1,19 @@ +# GetTimeOffRequestsResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**[TimeOffRequest]**](TimeOffRequest.md) | | +**meta** | [**Meta**](Meta.md) | | [optional] +**links** | [**Links**](Links.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/GetUploadSessionResponse.md b/docs/models/GetUploadSessionResponse.md new file mode 100644 index 0000000000..672cb25fc1 --- /dev/null +++ b/docs/models/GetUploadSessionResponse.md @@ -0,0 +1,17 @@ +# GetUploadSessionResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UploadSession**](UploadSession.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/GetUserResponse.md b/docs/models/GetUserResponse.md new file mode 100644 index 0000000000..443c10c29e --- /dev/null +++ b/docs/models/GetUserResponse.md @@ -0,0 +1,17 @@ +# GetUserResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**User**](User.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/GetUsersResponse.md b/docs/models/GetUsersResponse.md new file mode 100644 index 0000000000..9c04547563 --- /dev/null +++ b/docs/models/GetUsersResponse.md @@ -0,0 +1,19 @@ +# GetUsersResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**[User]**](User.md) | | +**meta** | [**Meta**](Meta.md) | | [optional] +**links** | [**Links**](Links.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/GetWebhookEventLogsResponse.md b/docs/models/GetWebhookEventLogsResponse.md new file mode 100644 index 0000000000..82326dc87d --- /dev/null +++ b/docs/models/GetWebhookEventLogsResponse.md @@ -0,0 +1,16 @@ +# GetWebhookEventLogsResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**data** | [**[WebhookEventLog]**](WebhookEventLog.md) | | +**meta** | [**Meta**](Meta.md) | | [optional] +**links** | [**Links**](Links.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/GetWebhookResponse.md b/docs/models/GetWebhookResponse.md new file mode 100644 index 0000000000..5305f0fab0 --- /dev/null +++ b/docs/models/GetWebhookResponse.md @@ -0,0 +1,14 @@ +# GetWebhookResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**data** | [**Webhook**](Webhook.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/GetWebhooksResponse.md b/docs/models/GetWebhooksResponse.md new file mode 100644 index 0000000000..9c7fd9e320 --- /dev/null +++ b/docs/models/GetWebhooksResponse.md @@ -0,0 +1,16 @@ +# GetWebhooksResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**data** | [**[Webhook]**](Webhook.md) | | +**meta** | [**Meta**](Meta.md) | | [optional] +**links** | [**Links**](Links.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/HrisCompany.md b/docs/models/HrisCompany.md new file mode 100644 index 0000000000..bc489e5eb9 --- /dev/null +++ b/docs/models/HrisCompany.md @@ -0,0 +1,26 @@ +# HrisCompany + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**legal_name** | **str** | | +**id** | **str** | | [optional] [readonly] +**display_name** | **str** | | [optional] +**subdomain** | **str** | | [optional] +**status** | **str** | | [optional] +**company_number** | **str, none_type** | An Company Number, Company ID or Company Code, is a unique number that has been assigned to each company. | [optional] +**addresses** | [**[Address]**](Address.md) | | [optional] +**phone_numbers** | [**[PhoneNumber]**](PhoneNumber.md) | | [optional] +**emails** | [**[Email]**](Email.md) | | [optional] +**websites** | [**[Website]**](Website.md) | | [optional] +**debtor_id** | **str** | | [optional] +**deleted** | **bool** | | [optional] [readonly] +**updated_by** | **str, none_type** | | [optional] [readonly] +**created_by** | **str, none_type** | | [optional] [readonly] +**updated_at** | **datetime** | | [optional] [readonly] +**created_at** | **datetime** | | [optional] [readonly] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/HrisEventType.md b/docs/models/HrisEventType.md new file mode 100644 index 0000000000..d2fbb42a24 --- /dev/null +++ b/docs/models/HrisEventType.md @@ -0,0 +1,11 @@ +# HrisEventType + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **str** | | must be one of ["*", "hris.employee.created", "hris.employee.updated", "hris.employee.deleted", "hris.company.created", "hris.company.updated", "hris.company.deleted", ] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/HrisJob.md b/docs/models/HrisJob.md new file mode 100644 index 0000000000..9b6114cba0 --- /dev/null +++ b/docs/models/HrisJob.md @@ -0,0 +1,19 @@ +# HrisJob + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | | [optional] [readonly] +**employee_id** | **str** | Id of the employee | [optional] +**title** | **str, none_type** | | [optional] +**start_date** | **date, none_type** | | [optional] +**end_date** | **date, none_type** | | [optional] +**employment_status** | **str, none_type** | | [optional] +**department** | **str, none_type** | Department name | [optional] +**location** | [**HrisJobLocation**](HrisJobLocation.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/HrisJobLocation.md b/docs/models/HrisJobLocation.md new file mode 100644 index 0000000000..d49299e5d6 --- /dev/null +++ b/docs/models/HrisJobLocation.md @@ -0,0 +1,12 @@ +# HrisJobLocation + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str, none_type** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/HrisJobs.md b/docs/models/HrisJobs.md new file mode 100644 index 0000000000..e35feaab89 --- /dev/null +++ b/docs/models/HrisJobs.md @@ -0,0 +1,13 @@ +# HrisJobs + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**employee** | [**Employee**](Employee.md) | | [optional] +**jobs** | [**[HrisJob]**](HrisJob.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/IdempotencyKey.md b/docs/models/IdempotencyKey.md new file mode 100644 index 0000000000..b9be7c6008 --- /dev/null +++ b/docs/models/IdempotencyKey.md @@ -0,0 +1,12 @@ +# IdempotencyKey + +A value you specify that uniquely identifies this request among requests you have sent. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **str** | A value you specify that uniquely identifies this request among requests you have sent. | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/Invoice.md b/docs/models/Invoice.md new file mode 100644 index 0000000000..5445802e63 --- /dev/null +++ b/docs/models/Invoice.md @@ -0,0 +1,43 @@ +# Invoice + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | | [optional] [readonly] +**downstream_id** | **str, none_type** | The third-party API ID of original entity | [optional] [readonly] +**type** | **str, none_type** | Invoice type | [optional] +**number** | **str, none_type** | Invoice number. | [optional] +**customer** | [**LinkedCustomer**](LinkedCustomer.md) | | [optional] +**invoice_date** | **date, none_type** | Date invoice was issued - YYYY-MM-DD. | [optional] +**due_date** | **date, none_type** | The invoice due date is the date on which a payment or invoice is scheduled to be received by the seller - YYYY-MM-DD. | [optional] +**terms** | **str, none_type** | Terms of payment. | [optional] +**po_number** | **str, none_type** | A PO Number uniquely identifies a purchase order and is generally defined by the buyer. The buyer will match the PO number in the invoice to the Purchase Order. | [optional] +**reference** | **str, none_type** | Optional invoice reference. | [optional] +**status** | **str, none_type** | Invoice status | [optional] +**invoice_sent** | **bool** | Invoice sent to contact/customer. | [optional] +**currency** | [**Currency**](Currency.md) | | [optional] +**currency_rate** | **float, none_type** | Currency Exchange Rate at the time entity was recorded/generated. | [optional] +**tax_inclusive** | **bool, none_type** | Amounts are including tax | [optional] +**sub_total** | **float, none_type** | Sub-total amount, normally before tax. | [optional] +**total_tax** | **float, none_type** | Total tax amount applied to this invoice. | [optional] +**tax_code** | **str, none_type** | Applicable tax id/code override if tax is not supplied on a line item basis. | [optional] +**discount_percentage** | **float, none_type** | Discount percentage applied to this invoice. | [optional] +**total** | **float, none_type** | Total amount of invoice, including tax. | [optional] +**balance** | **float, none_type** | Balance of invoice due. | [optional] +**deposit** | **float, none_type** | Amount of deposit made to this invoice. | [optional] +**customer_memo** | **str, none_type** | Customer memo | [optional] +**line_items** | [**[InvoiceLineItem]**](InvoiceLineItem.md) | | [optional] +**billing_address** | [**Address**](Address.md) | | [optional] +**shipping_address** | [**Address**](Address.md) | | [optional] +**template_id** | **str, none_type** | Optional invoice template | [optional] +**source_document_url** | **str, none_type** | URL link to a source document - shown as 'Go to [appName]' in the downstream app. Currently only supported for Xero. | [optional] +**row_version** | **str, none_type** | | [optional] +**updated_by** | **str, none_type** | | [optional] [readonly] +**created_by** | **str, none_type** | | [optional] [readonly] +**updated_at** | **datetime** | | [optional] [readonly] +**created_at** | **datetime** | | [optional] [readonly] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/InvoiceItem.md b/docs/models/InvoiceItem.md new file mode 100644 index 0000000000..724f144387 --- /dev/null +++ b/docs/models/InvoiceItem.md @@ -0,0 +1,32 @@ +# InvoiceItem + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The ID of the item. | [optional] [readonly] +**name** | **str, none_type** | Item name | [optional] +**description** | **str, none_type** | A short description of the item | [optional] +**code** | **str, none_type** | User defined item code | [optional] +**sold** | **bool, none_type** | Item will be available on sales transactions | [optional] +**purchased** | **bool, none_type** | Item is available for purchase transactions | [optional] +**tracked** | **bool, none_type** | Item is inventoried | [optional] +**inventory_date** | **date, none_type** | The date of opening balance if inventory item is tracked - YYYY-MM-DD. | [optional] +**type** | **str, none_type** | Item type | [optional] +**sales_details** | [**InvoiceItemSalesDetails**](InvoiceItemSalesDetails.md) | | [optional] +**purchase_details** | [**InvoiceItemSalesDetails**](InvoiceItemSalesDetails.md) | | [optional] +**quantity** | **float, none_type** | | [optional] +**unit_price** | **float, none_type** | | [optional] +**asset_account** | [**LinkedLedgerAccount**](LinkedLedgerAccount.md) | | [optional] +**income_account** | [**LinkedLedgerAccount**](LinkedLedgerAccount.md) | | [optional] +**expense_account** | [**LinkedLedgerAccount**](LinkedLedgerAccount.md) | | [optional] +**active** | **bool, none_type** | | [optional] +**row_version** | **str, none_type** | | [optional] +**updated_by** | **str, none_type** | | [optional] [readonly] +**created_by** | **str, none_type** | | [optional] [readonly] +**updated_at** | **datetime** | | [optional] [readonly] +**created_at** | **datetime** | | [optional] [readonly] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/InvoiceItemAssetAccount.md b/docs/models/InvoiceItemAssetAccount.md new file mode 100644 index 0000000000..1faf972d27 --- /dev/null +++ b/docs/models/InvoiceItemAssetAccount.md @@ -0,0 +1,11 @@ +# InvoiceItemAssetAccount + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **LinkedLedgerAccount** | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/InvoiceItemExpenseAccount.md b/docs/models/InvoiceItemExpenseAccount.md new file mode 100644 index 0000000000..77eba518b4 --- /dev/null +++ b/docs/models/InvoiceItemExpenseAccount.md @@ -0,0 +1,11 @@ +# InvoiceItemExpenseAccount + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **LinkedLedgerAccount** | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/InvoiceItemIncomeAccount.md b/docs/models/InvoiceItemIncomeAccount.md new file mode 100644 index 0000000000..b81cc58461 --- /dev/null +++ b/docs/models/InvoiceItemIncomeAccount.md @@ -0,0 +1,11 @@ +# InvoiceItemIncomeAccount + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **LinkedLedgerAccount** | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/InvoiceItemSalesDetails.md b/docs/models/InvoiceItemSalesDetails.md new file mode 100644 index 0000000000..dea785a53a --- /dev/null +++ b/docs/models/InvoiceItemSalesDetails.md @@ -0,0 +1,15 @@ +# InvoiceItemSalesDetails + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**unit_price** | **float, none_type** | | [optional] +**unit_of_measure** | **str, none_type** | Description of the unit type the item is sold as, ie: kg, hour. | [optional] +**tax_inclusive** | **bool, none_type** | Amounts are including tax | [optional] +**tax_rate** | [**LinkedTaxRate**](LinkedTaxRate.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/InvoiceItemsFilter.md b/docs/models/InvoiceItemsFilter.md new file mode 100644 index 0000000000..830fc0b19e --- /dev/null +++ b/docs/models/InvoiceItemsFilter.md @@ -0,0 +1,11 @@ +# InvoiceItemsFilter + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Name of Invoice Items to search for | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/InvoiceLineItem.md b/docs/models/InvoiceLineItem.md new file mode 100644 index 0000000000..3435c1829b --- /dev/null +++ b/docs/models/InvoiceLineItem.md @@ -0,0 +1,32 @@ +# InvoiceLineItem + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | | [optional] [readonly] +**row_id** | **str** | Row ID | [optional] +**code** | **str, none_type** | User defined item code | [optional] +**line_number** | **int, none_type** | Line number in the invoice | [optional] +**description** | **str, none_type** | User defined description | [optional] +**type** | **str, none_type** | Item type | [optional] +**tax_amount** | **float, none_type** | Tax amount | [optional] +**total_amount** | **float, none_type** | Total amount of the line item | [optional] +**quantity** | **float, none_type** | | [optional] +**unit_price** | **float, none_type** | | [optional] +**unit_of_measure** | **str, none_type** | Description of the unit type the item is sold as, ie: kg, hour. | [optional] +**discount_percentage** | **float, none_type** | Discount percentage applied to the line item when supported downstream. | [optional] +**location_id** | **str, none_type** | Location id | [optional] +**department_id** | **str, none_type** | Department id | [optional] +**item** | [**LinkedInvoiceItem**](LinkedInvoiceItem.md) | | [optional] +**tax_rate** | [**LinkedTaxRate**](LinkedTaxRate.md) | | [optional] +**ledger_account** | [**LinkedLedgerAccount**](LinkedLedgerAccount.md) | | [optional] +**row_version** | **str, none_type** | | [optional] +**updated_by** | **str, none_type** | | [optional] [readonly] +**created_by** | **str, none_type** | | [optional] [readonly] +**created_at** | **datetime** | | [optional] [readonly] +**updated_at** | **datetime** | | [optional] [readonly] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/InvoiceResponse.md b/docs/models/InvoiceResponse.md new file mode 100644 index 0000000000..40e7d68385 --- /dev/null +++ b/docs/models/InvoiceResponse.md @@ -0,0 +1,13 @@ +# InvoiceResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | | [optional] [readonly] +**downstream_id** | **str, none_type** | The third-party API ID of original entity | [optional] [readonly] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/InvoicesSort.md b/docs/models/InvoicesSort.md new file mode 100644 index 0000000000..62693b3143 --- /dev/null +++ b/docs/models/InvoicesSort.md @@ -0,0 +1,12 @@ +# InvoicesSort + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**by** | **str** | The field on which to sort the Invoices | [optional] if omitted the server will use the default value of "updated_at" +**direction** | [**SortDirection**](SortDirection.md) | | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/Item.md b/docs/models/Item.md new file mode 100644 index 0000000000..71d01878fb --- /dev/null +++ b/docs/models/Item.md @@ -0,0 +1,39 @@ +# Item + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | | +**id** | **str** | | [optional] +**idempotency_key** | [**IdempotencyKey**](IdempotencyKey.md) | | [optional] +**description** | **str** | | [optional] +**abbreviation** | **str** | | [optional] +**product_type** | **str** | | [optional] +**price_amount** | **float** | | [optional] +**pricing_type** | **str** | | [optional] +**price_currency** | [**Currency**](Currency.md) | | [optional] +**cost** | **float** | | [optional] +**tax_ids** | **[str]** | A list of Tax IDs for the product. | [optional] +**absent_at_location_ids** | **[str]** | A list of locations where the object is not present, even if present_at_all_locations is true. This can include locations that are deactivated. | [optional] +**present_at_all_locations** | **bool** | | [optional] +**available_for_pickup** | **bool** | | [optional] +**available_online** | **bool** | | [optional] +**sku** | **str** | SKU of the item | [optional] +**code** | **str** | Product code, e.g. UPC or EAN | [optional] +**categories** | **[bool, date, datetime, dict, float, int, list, str, none_type]** | | [optional] +**options** | **[bool, date, datetime, dict, float, int, list, str, none_type]** | List of options pertaining to this item's attribute variation | [optional] +**variations** | **[bool, date, datetime, dict, float, int, list, str, none_type]** | | [optional] +**modifier_groups** | **[bool, date, datetime, dict, float, int, list, str, none_type]** | | [optional] +**available** | **bool, none_type** | | [optional] +**hidden** | **bool, none_type** | | [optional] +**version** | **str, none_type** | | [optional] [readonly] +**deleted** | **bool, none_type** | | [optional] +**updated_by** | **str, none_type** | | [optional] [readonly] +**created_by** | **str, none_type** | | [optional] [readonly] +**updated_at** | **datetime** | | [optional] [readonly] +**created_at** | **datetime** | | [optional] [readonly] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/Job.md b/docs/models/Job.md new file mode 100644 index 0000000000..3c75573270 --- /dev/null +++ b/docs/models/Job.md @@ -0,0 +1,48 @@ +# Job + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | | [optional] [readonly] +**slug** | **str, none_type** | | [optional] +**title** | **str, none_type** | | [optional] +**sequence** | **int** | Sequence in relation to other jobs. | [optional] +**visibility** | **str** | The visibility of the job | [optional] +**status** | [**JobStatus**](JobStatus.md) | | [optional] +**code** | **str** | The code of the job. | [optional] +**language** | **str, none_type** | language code according to ISO 639-1. For the United States - EN | [optional] +**employment_terms** | **str, none_type** | | [optional] +**experience** | **str** | Level of experience required for the job role. | [optional] +**remote** | **bool, none_type** | Specifies whether the posting is for a remote job. | [optional] +**requisition_id** | **str** | A job's Requisition ID (Req ID) allows your organization to identify and track a job based on alphanumeric naming conventions unique to your company's internal processes. | [optional] +**department** | [**Department**](Department.md) | | [optional] +**branch** | [**Branch**](Branch.md) | | [optional] +**recruiters** | **[str], none_type** | The recruiter is generally someone who is tasked to help the hiring manager find and screen qualified applicant | [optional] +**hiring_managers** | **[bool, date, datetime, dict, float, int, list, str, none_type]** | | [optional] +**followers** | **[str], none_type** | | [optional] +**description** | **str, none_type** | | [optional] +**description_html** | **str, none_type** | The job description in HTML format | [optional] +**blocks** | **[bool, date, datetime, dict, float, int, list, str, none_type]** | | [optional] +**closing** | **str, none_type** | | [optional] +**closing_html** | **str, none_type** | The closing section of the job description in HTML format | [optional] +**closing_date** | **date, none_type** | | [optional] +**salary** | [**JobSalary**](JobSalary.md) | | [optional] +**url** | **str, none_type** | URL of the job description | [optional] +**job_portal_url** | **str, none_type** | URL of the job portal | [optional] +**confidential** | **bool** | | [optional] +**available_to_employees** | **bool** | Specifies whether an employee of the organization can apply for the job. | [optional] +**tags** | [**Tags**](Tags.md) | | [optional] +**addresses** | [**[Address]**](Address.md) | | [optional] +**record_url** | **str, none_type** | | [optional] +**deleted** | **bool, none_type** | | [optional] +**owner_id** | **str** | | [optional] +**published_at** | **datetime** | | [optional] [readonly] +**updated_by** | **str, none_type** | | [optional] [readonly] +**created_by** | **str, none_type** | | [optional] [readonly] +**updated_at** | **datetime** | | [optional] [readonly] +**created_at** | **datetime** | | [optional] [readonly] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/JobSalary.md b/docs/models/JobSalary.md new file mode 100644 index 0000000000..9e68580471 --- /dev/null +++ b/docs/models/JobSalary.md @@ -0,0 +1,14 @@ +# JobSalary + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**min** | **int** | Minimum salary payable for the job role. | [optional] +**max** | **int** | Maximum salary payable for the job role. | [optional] +**currency** | [**Currency**](Currency.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/JobStatus.md b/docs/models/JobStatus.md new file mode 100644 index 0000000000..c13b1cd899 --- /dev/null +++ b/docs/models/JobStatus.md @@ -0,0 +1,12 @@ +# JobStatus + +The status of the job. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **str** | The status of the job. | must be one of ["draft", "internal", "published", "completed", "on-hold", "private", ] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/JobsFilter.md b/docs/models/JobsFilter.md new file mode 100644 index 0000000000..e40430dcd9 --- /dev/null +++ b/docs/models/JobsFilter.md @@ -0,0 +1,11 @@ +# JobsFilter + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**job_id** | **str** | Id of the job to filter on | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/Lead.md b/docs/models/Lead.md new file mode 100644 index 0000000000..8af288043d --- /dev/null +++ b/docs/models/Lead.md @@ -0,0 +1,36 @@ +# Lead + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | | +**company_name** | **str, none_type** | | +**id** | **str** | | [optional] [readonly] +**owner_id** | **str** | | [optional] +**company_id** | **str, none_type** | | [optional] +**contact_id** | **str, none_type** | | [optional] +**lead_source** | **str, none_type** | | [optional] +**first_name** | **str, none_type** | | [optional] +**last_name** | **str, none_type** | | [optional] +**description** | **str, none_type** | | [optional] +**prefix** | **str, none_type** | | [optional] +**title** | **str, none_type** | | [optional] +**language** | **str, none_type** | language code according to ISO 639-1. For the United States - EN | [optional] +**status** | **str, none_type** | | [optional] +**monetary_amount** | **float, none_type** | | [optional] +**currency** | [**Currency**](Currency.md) | | [optional] +**fax** | **str, none_type** | | [optional] +**websites** | [**[Website]**](Website.md) | | [optional] +**addresses** | [**[Address]**](Address.md) | | [optional] +**social_links** | [**[SocialLink]**](SocialLink.md) | | [optional] +**phone_numbers** | [**[PhoneNumber]**](PhoneNumber.md) | | [optional] +**emails** | [**[Email]**](Email.md) | | [optional] +**custom_fields** | [**[CustomField]**](CustomField.md) | | [optional] +**tags** | [**Tags**](Tags.md) | | [optional] +**updated_at** | **str** | | [optional] [readonly] +**created_at** | **str** | | [optional] [readonly] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/LeadEventType.md b/docs/models/LeadEventType.md new file mode 100644 index 0000000000..6e7bf3e001 --- /dev/null +++ b/docs/models/LeadEventType.md @@ -0,0 +1,11 @@ +# LeadEventType + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **str** | | must be one of ["*", "lead.lead.created", "lead.lead.updated", "lead.lead.deleted", ] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/LeadsFilter.md b/docs/models/LeadsFilter.md new file mode 100644 index 0000000000..fd8f664b6c --- /dev/null +++ b/docs/models/LeadsFilter.md @@ -0,0 +1,14 @@ +# LeadsFilter + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Name of the lead to filter on | [optional] +**first_name** | **str** | First name of the lead to filter on | [optional] +**last_name** | **str** | Last name of the lead to filter on | [optional] +**email** | **str** | E-mail of the lead to filter on | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/LeadsSort.md b/docs/models/LeadsSort.md new file mode 100644 index 0000000000..125950854e --- /dev/null +++ b/docs/models/LeadsSort.md @@ -0,0 +1,12 @@ +# LeadsSort + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**by** | **str** | The field on which to sort the Leads | [optional] +**direction** | [**SortDirection**](SortDirection.md) | | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/LedgerAccount.md b/docs/models/LedgerAccount.md new file mode 100644 index 0000000000..ac7ab5d115 --- /dev/null +++ b/docs/models/LedgerAccount.md @@ -0,0 +1,41 @@ +# LedgerAccount + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | | [optional] [readonly] +**display_id** | **str** | The human readable display ID used when displaying the account | [optional] +**nominal_code** | **str, none_type** | The nominal code of the ledger account. | [optional] +**code** | **str, none_type** | The code assigned to the account. | [optional] +**classification** | **str, none_type** | The classification of account. | [optional] +**type** | **str** | The type of account. | [optional] +**sub_type** | **str, none_type** | The sub type of account. | [optional] +**name** | **str, none_type** | The name of the account. | [optional] +**fully_qualified_name** | **str, none_type** | The fully qualified name of the account. | [optional] +**description** | **str, none_type** | The description of the account. | [optional] +**opening_balance** | **float, none_type** | The opening balance of the account. | [optional] +**current_balance** | **float, none_type** | The current balance of the account. | [optional] +**currency** | [**Currency**](Currency.md) | | [optional] +**tax_type** | **str, none_type** | The tax type of the account. | [optional] +**tax_rate** | [**LinkedTaxRate**](LinkedTaxRate.md) | | [optional] +**level** | **float, none_type** | | [optional] +**active** | **bool, none_type** | Whether the account is active or not. | [optional] +**status** | **str, none_type** | The status of the account. | [optional] +**header** | **bool, none_type** | Whether the account is a header or not. | [optional] +**bank_account** | [**BankAccount**](BankAccount.md) | | [optional] +**categories** | [**[LedgerAccountCategories]**](LedgerAccountCategories.md) | The categories of the account. | [optional] [readonly] +**parent_account** | [**LedgerAccountParentAccount**](LedgerAccountParentAccount.md) | | [optional] +**sub_account** | **bool, none_type** | Whether the account is a sub account or not. | [optional] +**sub_accounts** | **[bool, date, datetime, dict, float, int, list, str, none_type]** | The sub accounts of the account. | [optional] [readonly] +**last_reconciliation_date** | **date, none_type** | Reconciliation Date means the last calendar day of each Reconciliation Period. | [optional] +**row_version** | **str, none_type** | | [optional] +**updated_by** | **str, none_type** | | [optional] [readonly] +**created_by** | **str, none_type** | | [optional] [readonly] +**updated_at** | **datetime** | | [optional] [readonly] +**created_at** | **datetime** | | [optional] [readonly] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/LedgerAccountCategories.md b/docs/models/LedgerAccountCategories.md new file mode 100644 index 0000000000..27d3c80655 --- /dev/null +++ b/docs/models/LedgerAccountCategories.md @@ -0,0 +1,13 @@ +# LedgerAccountCategories + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | | [optional] [readonly] +**name** | **str** | The name of the category. | [optional] [readonly] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/LedgerAccountParentAccount.md b/docs/models/LedgerAccountParentAccount.md new file mode 100644 index 0000000000..5a8a4bb826 --- /dev/null +++ b/docs/models/LedgerAccountParentAccount.md @@ -0,0 +1,14 @@ +# LedgerAccountParentAccount + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The ID of the parent account. | [optional] +**name** | **str** | The name of the parent account. | [optional] +**display_id** | **str** | The human readable display ID used when displaying the parent account | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/LedgerAccounts.md b/docs/models/LedgerAccounts.md new file mode 100644 index 0000000000..9f9ba4b34a --- /dev/null +++ b/docs/models/LedgerAccounts.md @@ -0,0 +1,11 @@ +# LedgerAccounts + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | [**[LedgerAccount]**](LedgerAccount.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/LinkedConnectorResource.md b/docs/models/LinkedConnectorResource.md new file mode 100644 index 0000000000..0028cfec30 --- /dev/null +++ b/docs/models/LinkedConnectorResource.md @@ -0,0 +1,16 @@ +# LinkedConnectorResource + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | ID of the resource, typically a lowercased version of name. | [optional] +**name** | **str** | Name of the resource (plural) | [optional] +**status** | [**ResourceStatus**](ResourceStatus.md) | | [optional] +**downstream_id** | **str** | ID of the resource in the Connector's API (downstream) | [optional] +**downstream_name** | **str** | Name of the resource in the Connector's API (downstream) | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/LinkedCustomer.md b/docs/models/LinkedCustomer.md new file mode 100644 index 0000000000..8c27794c04 --- /dev/null +++ b/docs/models/LinkedCustomer.md @@ -0,0 +1,17 @@ +# LinkedCustomer + +The customer this entity is linked to. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The ID of the customer this entity is linked to. | +**display_id** | **str, none_type** | The display ID of the customer. | [optional] [readonly] +**display_name** | **str, none_type** | The display name of the customer. | [optional] +**name** | **str** | The name of the customer. Deprecated, use display_name instead. | [optional] +**company_name** | **str, none_type** | The company name of the customer. | [optional] [readonly] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/LinkedFolder.md b/docs/models/LinkedFolder.md new file mode 100644 index 0000000000..d495981f34 --- /dev/null +++ b/docs/models/LinkedFolder.md @@ -0,0 +1,13 @@ +# LinkedFolder + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | | [readonly] +**name** | **str** | The name of the folder | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/LinkedInvoiceItem.md b/docs/models/LinkedInvoiceItem.md new file mode 100644 index 0000000000..52a996e44d --- /dev/null +++ b/docs/models/LinkedInvoiceItem.md @@ -0,0 +1,14 @@ +# LinkedInvoiceItem + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str, none_type** | ID of the linked item. A reference to the [invoice item](https://developers.apideck.com/apis/accounting/reference#tag/Invoice-Items) that was used to create this line item | [optional] +**code** | **str, none_type** | User defined item code | [optional] [readonly] +**name** | **str, none_type** | User defined item name | [optional] [readonly] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/LinkedLedgerAccount.md b/docs/models/LinkedLedgerAccount.md new file mode 100644 index 0000000000..c8e64db401 --- /dev/null +++ b/docs/models/LinkedLedgerAccount.md @@ -0,0 +1,15 @@ +# LinkedLedgerAccount + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The unique identifier for the account. | [optional] +**name** | **str, none_type** | The name of the account. | [optional] [readonly] +**nominal_code** | **str, none_type** | The nominal code of the account. | [optional] +**code** | **str, none_type** | The code assigned to the account. | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/LinkedSupplier.md b/docs/models/LinkedSupplier.md new file mode 100644 index 0000000000..255a8d0a51 --- /dev/null +++ b/docs/models/LinkedSupplier.md @@ -0,0 +1,16 @@ +# LinkedSupplier + +The supplier this entity is linked to. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The ID of the supplier this entity is linked to. | +**display_name** | **str, none_type** | The display name of the supplier. | [optional] +**company_name** | **str, none_type** | The company name of the supplier. | [optional] [readonly] +**address** | [**Address**](Address.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/LinkedTaxRate.md b/docs/models/LinkedTaxRate.md new file mode 100644 index 0000000000..ecaa727015 --- /dev/null +++ b/docs/models/LinkedTaxRate.md @@ -0,0 +1,14 @@ +# LinkedTaxRate + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str, none_type** | The ID of the object. | [optional] +**code** | **str, none_type** | Tax rate code | [optional] [readonly] +**name** | **str, none_type** | Name of the tax rate | [optional] [readonly] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/Links.md b/docs/models/Links.md new file mode 100644 index 0000000000..c9dea85ac5 --- /dev/null +++ b/docs/models/Links.md @@ -0,0 +1,15 @@ +# Links + +Links to navigate to previous or next pages through the API + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**previous** | **str, none_type** | Link to navigate to the previous page through the API | [optional] +**current** | **str** | Link to navigate to the current page through the API | [optional] +**next** | **str, none_type** | Link to navigate to the previous page through the API | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/Location.md b/docs/models/Location.md new file mode 100644 index 0000000000..24cda14967 --- /dev/null +++ b/docs/models/Location.md @@ -0,0 +1,21 @@ +# Location + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | | [optional] [readonly] +**name** | **str, none_type** | The name of the location | [optional] +**business_name** | **str, none_type** | The business name of the location | [optional] +**address** | [**Address**](Address.md) | | [optional] +**status** | **str, none_type** | Status of this location. | [optional] +**merchant_id** | **str** | | [optional] +**currency** | [**Currency**](Currency.md) | | [optional] +**updated_by** | **str, none_type** | | [optional] [readonly] +**created_by** | **str, none_type** | | [optional] [readonly] +**updated_at** | **datetime** | | [optional] [readonly] +**created_at** | **datetime** | | [optional] [readonly] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/Log.md b/docs/models/Log.md new file mode 100644 index 0000000000..2520bcf2c6 --- /dev/null +++ b/docs/models/Log.md @@ -0,0 +1,31 @@ +# Log + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**api_style** | **str** | Indicates if the request was made via REST or Graphql endpoint. | +**base_url** | **str** | The Apideck base URL the request was made to. | +**child_request** | **bool** | Indicates whether or not this is a child or parent request. | +**consumer_id** | **str** | The consumer Id associated with the request. | +**duration** | **float** | The entire execution time in milliseconds it took to call the Apideck service provider. | +**execution** | **int** | The entire execution time in milliseconds it took to make the request. | +**has_children** | **bool** | When request is a parent request, this indicates if there are child requests associated. | +**http_method** | **str** | HTTP Method of request. | +**id** | **str** | UUID acting as Request Identifier. | +**latency** | **float** | Latency added by making this request via Unified Api. | +**operation** | [**LogOperation**](LogOperation.md) | | +**parent_id** | **str, none_type** | When request is a child request, this UUID indicates it's parent request. | +**path** | **str** | The path component of the URI the request was made to. | +**sandbox** | **bool** | Indicates whether the request was made using Apidecks sandbox credentials or not. | +**service** | [**LogService**](LogService.md) | | +**status_code** | **int** | HTTP Status code that was returned. | +**success** | **bool** | Whether or not the request was successful. | +**timestamp** | **str** | ISO Date and time when the request was made. | +**unified_api** | **str** | Which Unified Api request was made to. | +**error_message** | **str, none_type** | If error occurred, this is brief explanation | [optional] +**source_ip** | **str, none_type** | The IP address of the source of the request. | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/LogOperation.md b/docs/models/LogOperation.md new file mode 100644 index 0000000000..228bf0e18f --- /dev/null +++ b/docs/models/LogOperation.md @@ -0,0 +1,14 @@ +# LogOperation + +The request as defined in OpenApi Spec. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The OpenApi Operation Id associated with the request | +**name** | **str** | The OpenApi Operation name associated with the request | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/LogService.md b/docs/models/LogService.md new file mode 100644 index 0000000000..0d9d10dadd --- /dev/null +++ b/docs/models/LogService.md @@ -0,0 +1,14 @@ +# LogService + +Apideck service provider associated with request. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Apideck service provider id. | +**name** | **str** | Apideck service provider name. | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/LogsFilter.md b/docs/models/LogsFilter.md new file mode 100644 index 0000000000..a96bcb5216 --- /dev/null +++ b/docs/models/LogsFilter.md @@ -0,0 +1,14 @@ +# LogsFilter + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**connector_id** | **str, none_type** | | [optional] +**status_code** | **float, none_type** | | [optional] +**exclude_unified_apis** | **str, none_type** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/Merchant.md b/docs/models/Merchant.md new file mode 100644 index 0000000000..2f0e6192a6 --- /dev/null +++ b/docs/models/Merchant.md @@ -0,0 +1,23 @@ +# Merchant + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | | [optional] [readonly] +**name** | **str, none_type** | The name of the merchant | [optional] +**address** | [**Address**](Address.md) | | [optional] +**owner_id** | **str** | | [optional] +**main_location_id** | **str, none_type** | The main location ID of the merchant | [optional] +**status** | **str, none_type** | Status of this merchant. | [optional] +**service_charges** | [**[ServiceCharge]**](ServiceCharge.md) | | [optional] +**language** | **str, none_type** | language code according to ISO 639-1. For the United States - EN | [optional] +**currency** | [**Currency**](Currency.md) | | [optional] +**updated_by** | **str, none_type** | | [optional] [readonly] +**created_by** | **str, none_type** | | [optional] [readonly] +**updated_at** | **datetime** | | [optional] [readonly] +**created_at** | **datetime** | | [optional] [readonly] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/Message.md b/docs/models/Message.md new file mode 100644 index 0000000000..73c8382a31 --- /dev/null +++ b/docs/models/Message.md @@ -0,0 +1,31 @@ +# Message + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**_from** | **str** | The phone number that initiated the message. | +**to** | **str** | The phone number that received the message. | +**body** | **str** | The message text. | +**id** | **str** | | [optional] [readonly] +**subject** | **str** | | [optional] +**type** | **str** | Set to sms for SMS messages and mms for MMS messages. | [optional] +**number_of_units** | **int** | The number of units that make up the complete message. Messages can be split up due to the constraints of the message size. | [optional] [readonly] +**number_of_media_files** | **int** | The number of media files associated with the message. | [optional] [readonly] +**direction** | **str** | The direction of the message. | [optional] [readonly] +**status** | **str** | Status of the delivery of the message. | [optional] [readonly] +**scheduled_at** | **datetime** | The scheduled date and time of the message. | [optional] +**sent_at** | **datetime** | The date and time that the message was sent | [optional] [readonly] +**webhook_url** | **str** | Define a webhook to receive delivery notifications. | [optional] +**reference** | **str** | A client reference. | [optional] +**price** | [**Price**](Price.md) | | [optional] +**error** | [**Error**](Error.md) | | [optional] +**messaging_service_id** | **str** | The ID of the Messaging Service used with the message. In case of Plivo this links to the Powerpack ID. | [optional] +**updated_by** | **str, none_type** | | [optional] [readonly] +**created_by** | **str, none_type** | | [optional] [readonly] +**updated_at** | **datetime** | | [optional] [readonly] +**created_at** | **datetime** | | [optional] [readonly] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/Meta.md b/docs/models/Meta.md new file mode 100644 index 0000000000..3bf561e4b8 --- /dev/null +++ b/docs/models/Meta.md @@ -0,0 +1,14 @@ +# Meta + +Response metadata + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**items_on_page** | **int** | Number of items returned in the data property of the response | [optional] +**cursors** | [**MetaCursors**](MetaCursors.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/MetaCursors.md b/docs/models/MetaCursors.md new file mode 100644 index 0000000000..6529fee14e --- /dev/null +++ b/docs/models/MetaCursors.md @@ -0,0 +1,15 @@ +# MetaCursors + +Cursors to navigate to previous or next pages through the API + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**previous** | **str, none_type** | Cursor to navigate to the previous page of results through the API | [optional] +**current** | **str, none_type** | Cursor to navigate to the current page of results through the API | [optional] +**next** | **str, none_type** | Cursor to navigate to the next page of results through the API | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/Modifier.md b/docs/models/Modifier.md new file mode 100644 index 0000000000..c8070b057f --- /dev/null +++ b/docs/models/Modifier.md @@ -0,0 +1,22 @@ +# Modifier + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | | +**modifier_group_id** | **str** | | +**id** | **str** | | [optional] [readonly] +**idempotency_key** | [**IdempotencyKey**](IdempotencyKey.md) | | [optional] +**alternate_name** | **str** | | [optional] +**price_amount** | **float** | | [optional] +**currency** | [**Currency**](Currency.md) | | [optional] +**available** | **bool, none_type** | | [optional] +**updated_by** | **str, none_type** | | [optional] [readonly] +**created_by** | **str, none_type** | | [optional] [readonly] +**updated_at** | **datetime** | | [optional] [readonly] +**created_at** | **datetime** | | [optional] [readonly] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/ModifierGroup.md b/docs/models/ModifierGroup.md new file mode 100644 index 0000000000..a92aa742e1 --- /dev/null +++ b/docs/models/ModifierGroup.md @@ -0,0 +1,24 @@ +# ModifierGroup + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | | [optional] [readonly] +**name** | **str** | | [optional] +**alternate_name** | **str** | | [optional] +**minimum_required** | **int** | | [optional] +**maximum_allowed** | **int** | | [optional] +**selection_type** | **str** | | [optional] +**present_at_all_locations** | **bool** | | [optional] +**modifiers** | **[bool, date, datetime, dict, float, int, list, str, none_type]** | | [optional] +**deleted** | **bool, none_type** | | [optional] +**row_version** | **str, none_type** | | [optional] +**updated_by** | **str, none_type** | | [optional] [readonly] +**created_by** | **str, none_type** | | [optional] [readonly] +**updated_at** | **datetime** | | [optional] [readonly] +**created_at** | **datetime** | | [optional] [readonly] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/ModifierGroupFilter.md b/docs/models/ModifierGroupFilter.md new file mode 100644 index 0000000000..f1028c7a37 --- /dev/null +++ b/docs/models/ModifierGroupFilter.md @@ -0,0 +1,11 @@ +# ModifierGroupFilter + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**modifier_group_id** | **str** | Id of the job to filter on | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/NotFoundResponse.md b/docs/models/NotFoundResponse.md new file mode 100644 index 0000000000..94f5ced8e7 --- /dev/null +++ b/docs/models/NotFoundResponse.md @@ -0,0 +1,17 @@ +# NotFoundResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **float** | HTTP status code | [optional] +**error** | **str** | Contains an explanation of the status_code as defined in HTTP/1.1 standard (RFC 7231) | [optional] +**type_name** | **str** | The type of error returned | [optional] +**message** | **str** | A human-readable message providing more details about the error. | [optional] +**detail** | **bool, date, datetime, dict, float, int, list, str, none_type** | Contains parameter or domain specific information related to the error and why it occurred. | [optional] +**ref** | **str** | Link to documentation of error type | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/NotImplementedResponse.md b/docs/models/NotImplementedResponse.md new file mode 100644 index 0000000000..a3582793b5 --- /dev/null +++ b/docs/models/NotImplementedResponse.md @@ -0,0 +1,17 @@ +# NotImplementedResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **float** | HTTP status code | [optional] +**error** | **str** | Contains an explanation of the status_code as defined in HTTP/1.1 standard (RFC 7231) | [optional] +**type_name** | **str** | The type of error returned | [optional] +**message** | **str** | A human-readable message providing more details about the error. | [optional] +**detail** | **bool, date, datetime, dict, float, int, list, str, none_type** | Contains parameter or domain specific information related to the error and why it occurred. | [optional] +**ref** | **str** | Link to documentation of error type | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/Note.md b/docs/models/Note.md new file mode 100644 index 0000000000..bf47a69291 --- /dev/null +++ b/docs/models/Note.md @@ -0,0 +1,23 @@ +# Note + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | | [optional] [readonly] +**title** | **str** | | [optional] +**content** | **str** | | [optional] +**owner_id** | **str** | | [optional] +**contact_id** | **str, none_type** | | [optional] +**company_id** | **str, none_type** | | [optional] +**opportunity_id** | **str, none_type** | | [optional] +**lead_id** | **str, none_type** | | [optional] +**active** | **bool, none_type** | | [optional] +**updated_by** | **str, none_type** | | [optional] [readonly] +**created_by** | **str, none_type** | | [optional] [readonly] +**updated_at** | **str** | | [optional] [readonly] +**created_at** | **str** | | [optional] [readonly] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/OAuthGrantType.md b/docs/models/OAuthGrantType.md new file mode 100644 index 0000000000..30460744ea --- /dev/null +++ b/docs/models/OAuthGrantType.md @@ -0,0 +1,12 @@ +# OAuthGrantType + +OAuth grant type used by the connector. More info: https://oauth.net/2/grant-types + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **str** | OAuth grant type used by the connector. More info: https://oauth.net/2/grant-types | must be one of ["authorization_code", "client_credentials", "password", ] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/Offer.md b/docs/models/Offer.md new file mode 100644 index 0000000000..dca5f1f2b3 --- /dev/null +++ b/docs/models/Offer.md @@ -0,0 +1,16 @@ +# Offer + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | | [optional] [readonly] +**application_id** | **str** | | [optional] +**updated_by** | **str, none_type** | | [optional] [readonly] +**created_by** | **str, none_type** | | [optional] [readonly] +**updated_at** | **datetime** | | [optional] [readonly] +**created_at** | **datetime** | | [optional] [readonly] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/OpportunitiesFilter.md b/docs/models/OpportunitiesFilter.md new file mode 100644 index 0000000000..9090afe939 --- /dev/null +++ b/docs/models/OpportunitiesFilter.md @@ -0,0 +1,15 @@ +# OpportunitiesFilter + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**title** | **str** | Title of the opportunity to filter on | [optional] +**status** | **str** | Status to filter on | [optional] +**monetary_amount** | **float** | Monetary amount to filter on | [optional] +**win_probability** | **float** | Win probability to filter on | [optional] +**company_id** | **str** | Company ID to filter on | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/OpportunitiesSort.md b/docs/models/OpportunitiesSort.md new file mode 100644 index 0000000000..f6d6c57e3c --- /dev/null +++ b/docs/models/OpportunitiesSort.md @@ -0,0 +1,12 @@ +# OpportunitiesSort + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**by** | **str** | The field on which to sort the Opportunities | [optional] +**direction** | [**SortDirection**](SortDirection.md) | | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/Opportunity.md b/docs/models/Opportunity.md new file mode 100644 index 0000000000..e7a3b56edd --- /dev/null +++ b/docs/models/Opportunity.md @@ -0,0 +1,49 @@ +# Opportunity + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**title** | **str** | | +**primary_contact_id** | **str, none_type** | | +**id** | **str** | | [optional] [readonly] +**description** | **str, none_type** | | [optional] +**type** | **str, none_type** | | [optional] +**monetary_amount** | **float, none_type** | | [optional] +**currency** | [**Currency**](Currency.md) | | [optional] +**win_probability** | **float, none_type** | | [optional] +**expected_revenue** | **float, none_type** | Expected Revenue | [optional] [readonly] +**close_date** | **date, none_type** | | [optional] +**loss_reason_id** | **str, none_type** | | [optional] +**loss_reason** | **str, none_type** | | [optional] +**won_reason_id** | **str, none_type** | | [optional] +**won_reason** | **str, none_type** | | [optional] +**pipeline_id** | **str, none_type** | | [optional] +**pipeline_stage_id** | **str, none_type** | | [optional] +**source_id** | **str, none_type** | | [optional] +**lead_id** | **str, none_type** | | [optional] +**lead_source** | **str, none_type** | Lead source | [optional] +**contact_id** | **str, none_type** | | [optional] +**company_id** | **str, none_type** | | [optional] +**company_name** | **str, none_type** | | [optional] +**owner_id** | **str, none_type** | | [optional] +**priority** | **str, none_type** | | [optional] +**status** | **str, none_type** | | [optional] +**status_id** | **str, none_type** | | [optional] +**tags** | [**Tags**](Tags.md) | | [optional] +**interaction_count** | **float, none_type** | | [optional] [readonly] +**custom_fields** | [**[CustomField]**](CustomField.md) | | [optional] +**stage_last_changed_at** | **datetime, none_type** | | [optional] +**last_activity_at** | **str, none_type** | | [optional] [readonly] +**deleted** | **bool** | | [optional] [readonly] +**date_stage_changed** | **datetime, none_type** | | [optional] [readonly] +**date_last_contacted** | **datetime, none_type** | | [optional] [readonly] +**date_lead_created** | **datetime, none_type** | | [optional] [readonly] +**updated_by** | **str, none_type** | | [optional] [readonly] +**created_by** | **str, none_type** | | [optional] [readonly] +**updated_at** | **datetime** | | [optional] [readonly] +**created_at** | **datetime** | | [optional] [readonly] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/Order.md b/docs/models/Order.md new file mode 100644 index 0000000000..b8f7d58e3e --- /dev/null +++ b/docs/models/Order.md @@ -0,0 +1,52 @@ +# Order + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**merchant_id** | **str** | | +**location_id** | **str** | | +**id** | **str** | | [optional] [readonly] +**idempotency_key** | [**IdempotencyKey**](IdempotencyKey.md) | | [optional] +**order_number** | **str** | | [optional] +**order_date** | **date, none_type** | | [optional] +**closed_date** | **date, none_type** | | [optional] +**reference_id** | **str, none_type** | An optional user-defined reference ID that associates this record with another entity in an external system. For example, a customer ID from an external customer management system. | [optional] +**status** | **str** | Order status. Clover specific: If no value is set, the status defaults to hidden, which indicates a hidden order. A hidden order is not displayed in user interfaces and can only be retrieved by its id. When creating an order via the REST API the value must be manually set to 'open'. More info [https://docs.clover.com/reference/orderupdateorder]() | [optional] +**payment_status** | **str** | Is this order paid or not? | [optional] +**currency** | [**Currency**](Currency.md) | | [optional] +**title** | **str** | | [optional] +**note** | **str** | A note with information about this order, may be printed on the order receipt and displayed in apps | [optional] +**customer_id** | **str** | | [optional] +**employee_id** | **str** | | [optional] +**order_type_id** | **str** | | [optional] +**table** | **str** | | [optional] +**seat** | **str** | | [optional] +**total_amount** | **int, none_type** | | [optional] +**total_tip** | **int, none_type** | | [optional] +**total_tax** | **int, none_type** | | [optional] +**total_discount** | **int, none_type** | | [optional] +**total_refund** | **int, none_type** | | [optional] +**total_service_charge** | **int, none_type** | | [optional] +**refunded** | **bool** | | [optional] +**customers** | [**[OrderCustomers]**](OrderCustomers.md) | | [optional] +**fulfillments** | [**[OrderFulfillments]**](OrderFulfillments.md) | | [optional] +**line_items** | [**[OrderLineItems]**](OrderLineItems.md) | | [optional] +**payments** | [**[OrderPayments]**](OrderPayments.md) | | [optional] +**service_charges** | [**ServiceCharges**](ServiceCharges.md) | | [optional] +**refunds** | [**[OrderRefunds]**](OrderRefunds.md) | | [optional] +**taxes** | **[bool, date, datetime, dict, float, int, list, str, none_type]** | | [optional] +**discounts** | [**[OrderDiscounts]**](OrderDiscounts.md) | | [optional] +**tenders** | [**[OrderTenders]**](OrderTenders.md) | | [optional] +**source** | **str, none_type** | Source of order. Indicates the way that the order was placed. | [optional] [readonly] +**voided** | **bool** | | [optional] +**voided_at** | **datetime** | | [optional] [readonly] +**version** | **str, none_type** | | [optional] +**updated_by** | **str, none_type** | | [optional] [readonly] +**created_by** | **str, none_type** | | [optional] [readonly] +**updated_at** | **datetime** | | [optional] [readonly] +**created_at** | **datetime** | | [optional] [readonly] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/OrderCustomers.md b/docs/models/OrderCustomers.md new file mode 100644 index 0000000000..c4e77cc3df --- /dev/null +++ b/docs/models/OrderCustomers.md @@ -0,0 +1,16 @@ +# OrderCustomers + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**first_name** | **str, none_type** | | [optional] +**middle_name** | **str, none_type** | | [optional] +**last_name** | **str, none_type** | | [optional] +**phone_numbers** | [**[PhoneNumber]**](PhoneNumber.md) | | [optional] +**emails** | [**[Email]**](Email.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/OrderDiscounts.md b/docs/models/OrderDiscounts.md new file mode 100644 index 0000000000..6c361d1a60 --- /dev/null +++ b/docs/models/OrderDiscounts.md @@ -0,0 +1,18 @@ +# OrderDiscounts + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | | [optional] [readonly] +**product_id** | **str** | | [optional] [readonly] +**name** | **str** | | [optional] +**type** | **str** | | [optional] +**amount** | **int** | | [optional] +**currency** | [**Currency**](Currency.md) | | [optional] +**scope** | **str** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/OrderFulfillments.md b/docs/models/OrderFulfillments.md new file mode 100644 index 0000000000..a99e44dce1 --- /dev/null +++ b/docs/models/OrderFulfillments.md @@ -0,0 +1,16 @@ +# OrderFulfillments + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | | [optional] +**status** | **str** | The state of the fulfillment. | [optional] +**type** | **str** | | [optional] +**pickup_details** | [**OrderPickupDetails**](OrderPickupDetails.md) | | [optional] +**shipment_details** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/OrderLineItems.md b/docs/models/OrderLineItems.md new file mode 100644 index 0000000000..1011ff39a5 --- /dev/null +++ b/docs/models/OrderLineItems.md @@ -0,0 +1,22 @@ +# OrderLineItems + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | | [optional] [readonly] +**name** | **str** | | [optional] +**item** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional] +**total_tax** | **int, none_type** | | [optional] +**total_discount** | **int, none_type** | | [optional] +**total_amount** | **int, none_type** | | [optional] +**quantity** | **float, none_type** | | [optional] +**unit_price** | **float, none_type** | | [optional] +**applied_taxes** | **[bool, date, datetime, dict, float, int, list, str, none_type]** | | [optional] +**applied_discounts** | **[bool, date, datetime, dict, float, int, list, str, none_type]** | | [optional] +**modifiers** | **[bool, date, datetime, dict, float, int, list, str, none_type]** | Customizable options – toppings, add-ons, or special requests – create item modifiers. Modifiers that are applied to items will display on your customers’ digital receipts | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/OrderPayments.md b/docs/models/OrderPayments.md new file mode 100644 index 0000000000..8d36541eea --- /dev/null +++ b/docs/models/OrderPayments.md @@ -0,0 +1,14 @@ +# OrderPayments + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | | [optional] [readonly] +**amount** | **int** | | [optional] +**currency** | [**Currency**](Currency.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/OrderPickupDetails.md b/docs/models/OrderPickupDetails.md new file mode 100644 index 0000000000..c957b53c91 --- /dev/null +++ b/docs/models/OrderPickupDetails.md @@ -0,0 +1,29 @@ +# OrderPickupDetails + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**accepted_at** | **datetime, none_type** | | [optional] [readonly] +**auto_complete_duration** | **str, none_type** | The duration of time after which an open and accepted pickup fulfillment is automatically moved to the COMPLETED state. The duration must be in RFC 3339 format (for example, 'P1W3D'). | [optional] +**cancel_reason** | **str, none_type** | A description of why the pickup was canceled. | [optional] +**expires_at** | **datetime** | Indicating when this fulfillment expires if it is not accepted. The timestamp must be in RFC 3339 format (for example, \"2016-09-04T23:59:33.123Z\"). The expiration time can only be set up to 7 days in the future. If `expires_at` is not set, this pickup fulfillment is automatically accepted when placed. | [optional] +**schedule_type** | **str** | The schedule type of the pickup fulfillment. | [optional] if omitted the server will use the default value of "scheduled" +**pickup_at** | **datetime** | The timestamp that represents the start of the pickup window. Must be in RFC 3339 timestamp format, e.g., \"2016-09-04T23:59:33.123Z\". For fulfillments with the schedule type `ASAP`, this is automatically set to the current time plus the expected duration to prepare the fulfillment. | [optional] +**pickup_window_duration** | **str** | The window of time in which the order should be picked up after the `pickup_at` timestamp. Must be in RFC 3339 duration format, e.g., \"P1W3D\". Can be used as an informational guideline for merchants. | [optional] +**prep_time_duration** | **str** | The duration of time it takes to prepare this fulfillment. The duration must be in RFC 3339 format (for example, \"P1W3D\"). | [optional] +**note** | **str** | A note meant to provide additional instructions about the pickup fulfillment displayed in the Square Point of Sale application and set by the API. | [optional] +**placed_at** | **datetime** | Indicating when the fulfillment was placed. The timestamp must be in RFC 3339 format (for example, \"2016-09-04T23:59:33.123Z\"). | [optional] +**rejected_at** | **datetime** | Indicating when the fulfillment was rejected. The timestamp must be in RFC 3339 format (for example, \"2016-09-04T23:59:33.123Z\"). | [optional] +**ready_at** | **datetime** | Indicating when the fulfillment is marked as ready for pickup. The timestamp must be in RFC 3339 format (for example, \"2016-09-04T23:59:33.123Z\"). | [optional] +**expired_at** | **datetime** | Indicating when the fulfillment expired. The timestamp must be in RFC 3339 format (for example, \"2016-09-04T23:59:33.123Z\"). | [optional] +**picked_up_at** | **datetime** | Indicating when the fulfillment was picked up by the recipient. The timestamp must be in RFC 3339 format (for example, \"2016-09-04T23:59:33.123Z\"). | [optional] +**canceled_at** | **datetime** | Indicating when the fulfillment was canceled. The timestamp must be in RFC 3339 format (for example, \"2016-09-04T23:59:33.123Z\"). | [optional] +**is_curbside_pickup** | **bool** | If set to `true`, indicates that this pickup order is for curbside pickup, not in-store pickup. | [optional] +**curbside_pickup_details** | [**OrderPickupDetailsCurbsidePickupDetails**](OrderPickupDetailsCurbsidePickupDetails.md) | | [optional] +**recipient** | [**OrderPickupDetailsRecipient**](OrderPickupDetailsRecipient.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/OrderPickupDetailsCurbsidePickupDetails.md b/docs/models/OrderPickupDetailsCurbsidePickupDetails.md new file mode 100644 index 0000000000..fc3a83807e --- /dev/null +++ b/docs/models/OrderPickupDetailsCurbsidePickupDetails.md @@ -0,0 +1,14 @@ +# OrderPickupDetailsCurbsidePickupDetails + +Specific details for curbside pickup. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**curbside_details** | **str** | Specific details for curbside pickup, such as parking number and vehicle model. | [optional] +**buyer_arrived_at** | **datetime** | Indicating when the buyer arrived and is waiting for pickup. The timestamp must be in RFC 3339 format (for example, \"2016-09-04T23:59:33.123Z\"). | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/OrderPickupDetailsRecipient.md b/docs/models/OrderPickupDetailsRecipient.md new file mode 100644 index 0000000000..a775334a41 --- /dev/null +++ b/docs/models/OrderPickupDetailsRecipient.md @@ -0,0 +1,16 @@ +# OrderPickupDetailsRecipient + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**customer_id** | **str** | | [optional] +**display_name** | **str** | | [optional] +**address** | [**Address**](Address.md) | | [optional] +**phone_number** | [**PhoneNumber**](PhoneNumber.md) | | [optional] +**email** | [**Email**](Email.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/OrderRefunds.md b/docs/models/OrderRefunds.md new file mode 100644 index 0000000000..1fe508c3a7 --- /dev/null +++ b/docs/models/OrderRefunds.md @@ -0,0 +1,19 @@ +# OrderRefunds + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | | [optional] [readonly] +**location_id** | **str** | | [optional] [readonly] +**amount** | **int** | | [optional] +**currency** | [**Currency**](Currency.md) | | [optional] +**reason** | **str** | | [optional] +**status** | **str** | | [optional] +**tender_id** | **str** | | [optional] [readonly] +**transaction_id** | **str** | | [optional] [readonly] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/OrderTenders.md b/docs/models/OrderTenders.md new file mode 100644 index 0000000000..9d57d20e4f --- /dev/null +++ b/docs/models/OrderTenders.md @@ -0,0 +1,33 @@ +# OrderTenders + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | | [optional] [readonly] +**name** | **str** | | [optional] +**type** | **str** | | [optional] +**note** | **str** | | [optional] +**amount** | **float** | | [optional] +**percentage** | **float** | | [optional] +**currency** | [**Currency**](Currency.md) | | [optional] +**total_amount** | **int, none_type** | | [optional] +**total_tip** | **int, none_type** | | [optional] +**total_processing_fee** | **int, none_type** | | [optional] +**total_tax** | **int, none_type** | | [optional] +**total_discount** | **int, none_type** | | [optional] +**total_refund** | **int, none_type** | | [optional] +**total_service_charge** | **int, none_type** | | [optional] +**buyer_tendered_cash_amount** | **int, none_type** | The amount (in cents) of cash tendered by the buyer. Only applicable when the tender type is cash. | [optional] +**change_back_cash_amount** | **int, none_type** | The amount (in cents) of cash returned to the buyer. Only applicable when the tender type is cash. | [optional] +**card** | [**PaymentCard**](PaymentCard.md) | | [optional] +**card_status** | **str, none_type** | The status of the card. Only applicable when the tender type is card. | [optional] +**card_entry_method** | **str, none_type** | The entry method of the card. Only applicable when the tender type is card. | [optional] +**payment_id** | **str** | | [optional] [readonly] +**location_id** | **str** | | [optional] [readonly] +**transaction_id** | **str** | | [optional] [readonly] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/OrderType.md b/docs/models/OrderType.md new file mode 100644 index 0000000000..129a6812a8 --- /dev/null +++ b/docs/models/OrderType.md @@ -0,0 +1,17 @@ +# OrderType + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | | [optional] [readonly] +**name** | **str** | | [optional] +**default** | **bool** | | [optional] +**updated_by** | **str, none_type** | | [optional] [readonly] +**created_by** | **str, none_type** | | [optional] [readonly] +**updated_at** | **datetime** | | [optional] [readonly] +**created_at** | **datetime** | | [optional] [readonly] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/Owner.md b/docs/models/Owner.md new file mode 100644 index 0000000000..f591dd6c8f --- /dev/null +++ b/docs/models/Owner.md @@ -0,0 +1,14 @@ +# Owner + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | ID of the owner | [optional] [readonly] +**email** | **str** | Email of the owner | [optional] [readonly] +**name** | **str** | Name of the owner | [optional] [readonly] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/PaginationCoverage.md b/docs/models/PaginationCoverage.md new file mode 100644 index 0000000000..ee9619ee38 --- /dev/null +++ b/docs/models/PaginationCoverage.md @@ -0,0 +1,14 @@ +# PaginationCoverage + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**mode** | **str** | How pagination is implemented on this connector. Native mode means Apideck is using the pagination parameters of the connector. With virtual pagination, the connector does not support pagination, but Apideck emulates it. | [optional] +**paging_support** | **bool** | Indicates whether the connector supports paging through results using the cursor parameter. | [optional] +**limit_support** | **bool** | Indicates whether the connector supports changing the page size by using the limit parameter. | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/Passthrough.md b/docs/models/Passthrough.md new file mode 100644 index 0000000000..ae25857883 --- /dev/null +++ b/docs/models/Passthrough.md @@ -0,0 +1,12 @@ +# Passthrough + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**example_downstream_property** | **str** | All passthrough query parameters are passed along to the connector as is (?pass_through[search]=leads becomes ?search=leads) | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/Payment.md b/docs/models/Payment.md new file mode 100644 index 0000000000..a8ff37bdb8 --- /dev/null +++ b/docs/models/Payment.md @@ -0,0 +1,36 @@ +# Payment + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**total_amount** | **float** | Amount of payment | +**transaction_date** | **datetime** | Date transaction was entered - YYYY:MM::DDThh:mm:ss.sTZD | +**id** | **str** | Unique identifier representing the entity | [optional] [readonly] +**downstream_id** | **str, none_type** | The third-party API ID of original entity | [optional] [readonly] +**currency** | [**Currency**](Currency.md) | | [optional] +**currency_rate** | **float, none_type** | Currency Exchange Rate at the time entity was recorded/generated. | [optional] +**reference** | **str, none_type** | Optional payment reference message ie: Debit remittance detail. | [optional] +**payment_method** | **str, none_type** | Payment method | [optional] +**payment_method_reference** | **str, none_type** | Optional reference message returned by payment method on processing | [optional] +**accounts_receivable_account_type** | **str, none_type** | Type of accounts receivable account. | [optional] +**accounts_receivable_account_id** | **str, none_type** | Unique identifier for the account to allocate payment to. | [optional] +**account** | [**LinkedLedgerAccount**](LinkedLedgerAccount.md) | | [optional] +**customer** | [**LinkedCustomer**](LinkedCustomer.md) | | [optional] +**supplier** | [**LinkedSupplier**](LinkedSupplier.md) | | [optional] +**reconciled** | **bool** | Payment has been reconciled | [optional] +**status** | **str** | Status of payment | [optional] +**type** | **str** | Type of payment | [optional] +**allocations** | [**[PaymentAllocations]**](PaymentAllocations.md) | | [optional] +**note** | **str, none_type** | Optional note to be associated with the payment. | [optional] +**row_version** | **str, none_type** | | [optional] +**display_id** | **str, none_type** | Payment id to be displayed. | [optional] +**updated_by** | **str, none_type** | | [optional] [readonly] +**created_by** | **str, none_type** | | [optional] [readonly] +**created_at** | **datetime** | | [optional] [readonly] +**updated_at** | **datetime** | | [optional] [readonly] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/PaymentAllocations.md b/docs/models/PaymentAllocations.md new file mode 100644 index 0000000000..08f936bf59 --- /dev/null +++ b/docs/models/PaymentAllocations.md @@ -0,0 +1,15 @@ +# PaymentAllocations + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Unique identifier of entity this payment should be attributed to. | [optional] +**type** | **str** | Type of entity this payment should be attributed to. | [optional] +**code** | **str** | | [optional] [readonly] +**amount** | **float, none_type** | Amount of payment that should be attributed to this allocation. If null, the total_amount will be used. | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/PaymentCard.md b/docs/models/PaymentCard.md new file mode 100644 index 0000000000..c2e4e7c95f --- /dev/null +++ b/docs/models/PaymentCard.md @@ -0,0 +1,27 @@ +# PaymentCard + +A card's non-confidential details. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | | [optional] [readonly] +**bin** | **str, none_type** | The first six digits of the card number, known as the Bank Identification Number (BIN). | [optional] +**card_brand** | **str, none_type** | The first six digits of the card number, known as the Bank Identification Number (BIN). | [optional] +**card_type** | **str, none_type** | | [optional] +**prepaid_type** | **str, none_type** | | [optional] +**cardholder_name** | **str, none_type** | | [optional] +**customer_id** | **str, none_type** | | [optional] +**merchant_id** | **str** | | [optional] +**exp_month** | **int, none_type** | The expiration month of the associated card as an integer between 1 and 12. | [optional] +**exp_year** | **int, none_type** | The four-digit year of the card's expiration date. | [optional] +**fingerprint** | **str, none_type** | | [optional] +**last_4** | **str, none_type** | | [optional] +**enabled** | **bool, none_type** | Indicates whether or not a card can be used for payments. | [optional] +**billing_address** | [**Address**](Address.md) | | [optional] +**reference_id** | **str, none_type** | An optional user-defined reference ID that associates this record with another entity in an external system. For example, a customer ID from an external customer management system. | [optional] +**version** | **str, none_type** | | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/PaymentRequiredResponse.md b/docs/models/PaymentRequiredResponse.md new file mode 100644 index 0000000000..62ca8526e8 --- /dev/null +++ b/docs/models/PaymentRequiredResponse.md @@ -0,0 +1,17 @@ +# PaymentRequiredResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **float** | HTTP status code | [optional] +**error** | **str** | Contains an explanation of the status_code as defined in HTTP/1.1 standard (RFC 7231) | [optional] +**type_name** | **str** | The type of error returned | [optional] +**message** | **str** | A human-readable message providing more details about the error. | [optional] +**detail** | **str** | Contains parameter or domain specific information related to the error and why it occurred. | [optional] +**ref** | **str** | Link to documentation of error type | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/PaymentUnit.md b/docs/models/PaymentUnit.md new file mode 100644 index 0000000000..fa4eb18689 --- /dev/null +++ b/docs/models/PaymentUnit.md @@ -0,0 +1,11 @@ +# PaymentUnit + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **str** | | must be one of ["hour", "week", "month", "year", "paycheck", ] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/Payroll.md b/docs/models/Payroll.md new file mode 100644 index 0000000000..9b601d6d52 --- /dev/null +++ b/docs/models/Payroll.md @@ -0,0 +1,19 @@ +# Payroll + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | | [readonly] +**processed** | **bool** | Whether or not the payroll has been successfully processed. Note that processed payrolls cannot be updated. | +**check_date** | **str** | The date on which employees will be paid for the payroll. | +**start_date** | **str** | The start date, inclusive, of the pay period. | +**end_date** | **str** | The end date, inclusive, of the pay period. | +**company_id** | **str, none_type** | | [optional] +**processed_date** | **str, none_type** | The date the payroll was processed. | [optional] +**totals** | **PayrollTotals** | | [optional] +**compensations** | [**[Compensation]**](Compensation.md) | An array of compensations for the payroll. | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/PayrollTotals.md b/docs/models/PayrollTotals.md new file mode 100644 index 0000000000..f5862a22b3 --- /dev/null +++ b/docs/models/PayrollTotals.md @@ -0,0 +1,20 @@ +# PayrollTotals + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**company_debit** | **float** | The total company debit for the payroll. | [optional] +**tax_debit** | **float** | The total tax debit for the payroll. | [optional] +**check_amount** | **float** | The total check amount for the payroll. | [optional] +**net_pay** | **float** | The net pay amount for the payroll. | [optional] +**gross_pay** | **float** | The gross pay amount for the payroll. | [optional] +**employer_taxes** | **float** | The total amount of employer paid taxes for the payroll. | [optional] +**employee_taxes** | **float** | The total amount of employee paid taxes for the payroll. | [optional] +**employer_benefit_contributions** | **float** | The total amount of company contributed benefits for the payroll. | [optional] +**employee_benefit_deductions** | **float** | The total amount of employee deducted benefits for the payroll. | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/PayrollsFilter.md b/docs/models/PayrollsFilter.md new file mode 100644 index 0000000000..7f5d20a7ac --- /dev/null +++ b/docs/models/PayrollsFilter.md @@ -0,0 +1,12 @@ +# PayrollsFilter + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**start_date** | **str** | Return payrolls whose pay period is after the start date | [optional] +**end_date** | **str** | Return payrolls whose pay period is before the end date | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/PhoneNumber.md b/docs/models/PhoneNumber.md new file mode 100644 index 0000000000..61a7fbe900 --- /dev/null +++ b/docs/models/PhoneNumber.md @@ -0,0 +1,16 @@ +# PhoneNumber + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**number** | **str** | | +**id** | **str, none_type** | | [optional] +**country_code** | **str, none_type** | | [optional] +**area_code** | **str, none_type** | | [optional] +**extension** | **str, none_type** | | [optional] +**type** | **str** | | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/Pipeline.md b/docs/models/Pipeline.md new file mode 100644 index 0000000000..7a500b9524 --- /dev/null +++ b/docs/models/Pipeline.md @@ -0,0 +1,20 @@ +# Pipeline + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | | +**id** | **str** | | [optional] +**currency** | [**Currency**](Currency.md) | | [optional] +**archived** | **bool** | | [optional] +**active** | **bool** | | [optional] +**display_order** | **int** | | [optional] +**win_probability_enabled** | **bool** | | [optional] +**stages** | [**[PipelineStages]**](PipelineStages.md) | | [optional] +**updated_at** | **datetime** | | [optional] [readonly] +**created_at** | **datetime** | | [optional] [readonly] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/PipelineStages.md b/docs/models/PipelineStages.md new file mode 100644 index 0000000000..3a1c41eb97 --- /dev/null +++ b/docs/models/PipelineStages.md @@ -0,0 +1,16 @@ +# PipelineStages + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | | [optional] [readonly] +**name** | **str** | | [optional] +**value** | **str** | | [optional] +**win_probability** | **int** | The expected probability of winning an Opportunity in this Pipeline Stage. Valid values are [0-100]. | [optional] +**display_order** | **int** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/PosBankAccount.md b/docs/models/PosBankAccount.md new file mode 100644 index 0000000000..5a8abfd9b1 --- /dev/null +++ b/docs/models/PosBankAccount.md @@ -0,0 +1,19 @@ +# PosBankAccount + +Card details for this payment. This field is currently not available. Reach out to our team for more info. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**bank_name** | **str** | The name of the bank associated with the bank account. | [optional] +**transfer_type** | **str** | The type of the bank transfer. The type can be `ACH` or `UNKNOWN`. | [optional] +**account_ownership_type** | **str** | The ownership type of the bank account performing the transfer. The type can be `INDIVIDUAL`, `COMPANY`, or `UNKNOWN`. | [optional] +**fingerprint** | **str** | Uniquely identifies the bank account for this seller and can be used to determine if payments are from the same bank account. | [optional] +**country** | **str, none_type** | country code according to ISO 3166-1 alpha-2. | [optional] +**statement_description** | **str** | The statement description as sent to the bank. | [optional] +**ach_details** | [**PosBankAccountAchDetails**](PosBankAccountAchDetails.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/PosBankAccountAchDetails.md b/docs/models/PosBankAccountAchDetails.md new file mode 100644 index 0000000000..a8fe01d062 --- /dev/null +++ b/docs/models/PosBankAccountAchDetails.md @@ -0,0 +1,15 @@ +# PosBankAccountAchDetails + +ACH-specific details about `BANK_ACCOUNT` type payments with the `transfer_type` of `ACH`. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**routing_number** | **str** | The routing number for the bank account. | [optional] +**account_number_suffix** | **str** | The last few digits of the bank account number. | [optional] +**account_type** | **str** | The type of the bank account performing the transfer. The account type can be `CHECKING`, `SAVINGS`, or `UNKNOWN`. | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/PosPayment.md b/docs/models/PosPayment.md new file mode 100644 index 0000000000..c625914747 --- /dev/null +++ b/docs/models/PosPayment.md @@ -0,0 +1,43 @@ +# PosPayment + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**source_id** | **str** | The ID for the source of funds for this payment. Square-only: This can be a payment token (card nonce) generated by the payment form or a card on file made linked to the customer. if recording a payment that the seller received outside of Square, specify either `CASH` or `EXTERNAL`. | +**order_id** | **str** | | +**customer_id** | **str** | | +**tender_id** | **str** | | +**amount** | **float** | | +**currency** | [**Currency**](Currency.md) | | +**id** | **str** | | [optional] [readonly] +**merchant_id** | **str** | | [optional] +**employee_id** | **str** | | [optional] +**location_id** | **str** | | [optional] +**device_id** | **str** | | [optional] +**external_payment_id** | **str** | | [optional] +**idempotency_key** | [**IdempotencyKey**](IdempotencyKey.md) | | [optional] +**tip** | **float** | | [optional] +**tax** | **float** | | [optional] +**total** | **float** | | [optional] +**app_fee** | **float** | The amount the developer is taking as a fee for facilitating the payment on behalf of the seller. | [optional] +**change_back_cash_amount** | **float** | | [optional] +**approved** | **float** | The initial amount of money approved for this payment. | [optional] +**refunded** | **float** | The initial amount of money approved for this payment. | [optional] +**processing_fees** | **[bool, date, datetime, dict, float, int, list, str, none_type]** | | [optional] +**source** | **str** | Source of this payment. | [optional] +**status** | **str** | Status of this payment. | [optional] +**cash** | [**CashDetails**](CashDetails.md) | | [optional] +**card_details** | [**PosPaymentCardDetails**](PosPaymentCardDetails.md) | | [optional] +**bank_account** | [**PosBankAccount**](PosBankAccount.md) | | [optional] +**wallet** | [**WalletDetails**](WalletDetails.md) | | [optional] +**external_details** | [**PosPaymentExternalDetails**](PosPaymentExternalDetails.md) | | [optional] +**service_charges** | [**ServiceCharges**](ServiceCharges.md) | | [optional] +**updated_by** | **str, none_type** | | [optional] [readonly] +**created_by** | **str, none_type** | | [optional] [readonly] +**updated_at** | **datetime** | | [optional] [readonly] +**created_at** | **datetime** | | [optional] [readonly] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/PosPaymentCardDetails.md b/docs/models/PosPaymentCardDetails.md new file mode 100644 index 0000000000..5231adc7c7 --- /dev/null +++ b/docs/models/PosPaymentCardDetails.md @@ -0,0 +1,12 @@ +# PosPaymentCardDetails + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**card** | [**PaymentCard**](PaymentCard.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/PosPaymentExternalDetails.md b/docs/models/PosPaymentExternalDetails.md new file mode 100644 index 0000000000..ff6ed4d7c3 --- /dev/null +++ b/docs/models/PosPaymentExternalDetails.md @@ -0,0 +1,16 @@ +# PosPaymentExternalDetails + +Details about an external payment. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **str** | The type of external payment the seller received. It can be one of the following: - CHECK - Paid using a physical check. - BANK_TRANSFER - Paid using external bank transfer. - OTHER\\_GIFT\\_CARD - Paid using a non-Square gift card. - CRYPTO - Paid using a crypto currency. - SQUARE_CASH - Paid using Square Cash App. - SOCIAL - Paid using peer-to-peer payment applications. - EXTERNAL - A third-party application gathered this payment outside of Square. - EMONEY - Paid using an E-money provider. - CARD - A credit or debit card that Square does not support. - STORED_BALANCE - Use for house accounts, store credit, and so forth. - FOOD_VOUCHER - Restaurant voucher provided by employers to employees to pay for meals - OTHER - A type not listed here. | +**source** | **str** | A description of the external payment source. For example, \"Food Delivery Service\". | +**source_id** | **str** | An ID to associate the payment to its originating source. | [optional] +**source_fee_amount** | **float** | The fees paid to the source. The amount minus this field is the net amount seller receives. | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/Price.md b/docs/models/Price.md new file mode 100644 index 0000000000..40beb9a191 --- /dev/null +++ b/docs/models/Price.md @@ -0,0 +1,15 @@ +# Price + +Price of the message. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**per_unit** | **str** | | [optional] [readonly] +**total_amount** | **str** | | [optional] [readonly] +**currency** | [**Currency**](Currency.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/ProfitAndLoss.md b/docs/models/ProfitAndLoss.md new file mode 100644 index 0000000000..67c8fb6f19 --- /dev/null +++ b/docs/models/ProfitAndLoss.md @@ -0,0 +1,21 @@ +# ProfitAndLoss + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**report_name** | **str** | The name of the report | +**currency** | **str** | | +**income** | [**ProfitAndLossIncome**](ProfitAndLossIncome.md) | | +**expenses** | [**ProfitAndLossExpenses**](ProfitAndLossExpenses.md) | | +**id** | **str** | | [optional] [readonly] +**start_date** | **str** | The start date of the report | [optional] +**end_date** | **str** | The start date of the report | [optional] +**customer_id** | **str** | Customer id | [optional] +**net_income** | [**ProfitAndLossNetIncome**](ProfitAndLossNetIncome.md) | | [optional] +**net_operating_income** | [**ProfitAndLossNetOperatingIncome**](ProfitAndLossNetOperatingIncome.md) | | [optional] +**gross_profit** | [**ProfitAndLossGrossProfit**](ProfitAndLossGrossProfit.md) | | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/ProfitAndLossExpenses.md b/docs/models/ProfitAndLossExpenses.md new file mode 100644 index 0000000000..31f072898e --- /dev/null +++ b/docs/models/ProfitAndLossExpenses.md @@ -0,0 +1,13 @@ +# ProfitAndLossExpenses + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**total** | **float, none_type** | Total expense | +**records** | [**ProfitAndLossRecords**](ProfitAndLossRecords.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/ProfitAndLossFilter.md b/docs/models/ProfitAndLossFilter.md new file mode 100644 index 0000000000..293aaf8136 --- /dev/null +++ b/docs/models/ProfitAndLossFilter.md @@ -0,0 +1,13 @@ +# ProfitAndLossFilter + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**customer_id** | **str** | Filter by customer id | [optional] +**start_date** | **str** | Filter by start date. If start date is given, end date is required. | [optional] +**end_date** | **str** | Filter by end date. If end date is given, start date is required. | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/ProfitAndLossGrossProfit.md b/docs/models/ProfitAndLossGrossProfit.md new file mode 100644 index 0000000000..8f80c7e0d8 --- /dev/null +++ b/docs/models/ProfitAndLossGrossProfit.md @@ -0,0 +1,13 @@ +# ProfitAndLossGrossProfit + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**total** | **float, none_type** | Total gross profit | +**records** | [**ProfitAndLossRecords**](ProfitAndLossRecords.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/ProfitAndLossIncome.md b/docs/models/ProfitAndLossIncome.md new file mode 100644 index 0000000000..3304355233 --- /dev/null +++ b/docs/models/ProfitAndLossIncome.md @@ -0,0 +1,13 @@ +# ProfitAndLossIncome + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**total** | **float, none_type** | Total income | +**records** | [**ProfitAndLossRecords**](ProfitAndLossRecords.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/ProfitAndLossNetIncome.md b/docs/models/ProfitAndLossNetIncome.md new file mode 100644 index 0000000000..f77314419e --- /dev/null +++ b/docs/models/ProfitAndLossNetIncome.md @@ -0,0 +1,13 @@ +# ProfitAndLossNetIncome + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**total** | **float, none_type** | Total net income | +**records** | [**ProfitAndLossRecords**](ProfitAndLossRecords.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/ProfitAndLossNetOperatingIncome.md b/docs/models/ProfitAndLossNetOperatingIncome.md new file mode 100644 index 0000000000..0c8c7c26ef --- /dev/null +++ b/docs/models/ProfitAndLossNetOperatingIncome.md @@ -0,0 +1,13 @@ +# ProfitAndLossNetOperatingIncome + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**total** | **float, none_type** | Total net operating income | +**records** | [**ProfitAndLossRecords**](ProfitAndLossRecords.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/ProfitAndLossRecord.md b/docs/models/ProfitAndLossRecord.md new file mode 100644 index 0000000000..bb33030fa9 --- /dev/null +++ b/docs/models/ProfitAndLossRecord.md @@ -0,0 +1,15 @@ +# ProfitAndLossRecord + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **str** | | +**id** | **str, none_type** | | [optional] +**title** | **str, none_type** | | [optional] +**value** | **float, none_type** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/ProfitAndLossRecords.md b/docs/models/ProfitAndLossRecords.md new file mode 100644 index 0000000000..18a59d95be --- /dev/null +++ b/docs/models/ProfitAndLossRecords.md @@ -0,0 +1,11 @@ +# ProfitAndLossRecords + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **[bool, date, datetime, dict, float, int, list, str, none_type], none_type** | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/ProfitAndLossSection.md b/docs/models/ProfitAndLossSection.md new file mode 100644 index 0000000000..54cf1f4df0 --- /dev/null +++ b/docs/models/ProfitAndLossSection.md @@ -0,0 +1,16 @@ +# ProfitAndLossSection + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **str** | | +**id** | **str, none_type** | | [optional] +**title** | **str, none_type** | | [optional] +**total** | **float, none_type** | | [optional] +**records** | [**ProfitAndLossRecords**](ProfitAndLossRecords.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/RequestCountAllocation.md b/docs/models/RequestCountAllocation.md new file mode 100644 index 0000000000..3affe357cd --- /dev/null +++ b/docs/models/RequestCountAllocation.md @@ -0,0 +1,14 @@ +# RequestCountAllocation + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**unify** | **float** | | [optional] +**proxy** | **float** | | [optional] +**vault** | **float** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/ResolveWebhookEventRequest.md b/docs/models/ResolveWebhookEventRequest.md new file mode 100644 index 0000000000..28609ecb60 --- /dev/null +++ b/docs/models/ResolveWebhookEventRequest.md @@ -0,0 +1,11 @@ +# ResolveWebhookEventRequest + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/ResolveWebhookEventsRequest.md b/docs/models/ResolveWebhookEventsRequest.md new file mode 100644 index 0000000000..eecf8cad63 --- /dev/null +++ b/docs/models/ResolveWebhookEventsRequest.md @@ -0,0 +1,11 @@ +# ResolveWebhookEventsRequest + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/ResolveWebhookResponse.md b/docs/models/ResolveWebhookResponse.md new file mode 100644 index 0000000000..c69f18c210 --- /dev/null +++ b/docs/models/ResolveWebhookResponse.md @@ -0,0 +1,15 @@ +# ResolveWebhookResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**request_id** | **str** | UUID of the request received | [optional] +**timestamp** | **str** | ISO Datetime webhook event was received | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/ResourceStatus.md b/docs/models/ResourceStatus.md new file mode 100644 index 0000000000..331ffcefb1 --- /dev/null +++ b/docs/models/ResourceStatus.md @@ -0,0 +1,12 @@ +# ResourceStatus + +Status of the resource. Resources with status live or beta are callable. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **str** | Status of the resource. Resources with status live or beta are callable. | must be one of ["live", "beta", "development", "upcoming", "considering", ] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/Schedule.md b/docs/models/Schedule.md new file mode 100644 index 0000000000..163817357b --- /dev/null +++ b/docs/models/Schedule.md @@ -0,0 +1,14 @@ +# Schedule + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | | [readonly] +**start_date** | **str** | The start date, inclusive, of the schedule period. | +**end_date** | **str** | The end date, inclusive, of the schedule period. | +**work_pattern** | [**ScheduleWorkPattern**](ScheduleWorkPattern.md) | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/ScheduleWorkPattern.md b/docs/models/ScheduleWorkPattern.md new file mode 100644 index 0000000000..5f96f64387 --- /dev/null +++ b/docs/models/ScheduleWorkPattern.md @@ -0,0 +1,13 @@ +# ScheduleWorkPattern + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**odd_weeks** | [**ScheduleWorkPatternOddWeeks**](ScheduleWorkPatternOddWeeks.md) | | [optional] +**even_weeks** | [**ScheduleWorkPatternOddWeeks**](ScheduleWorkPatternOddWeeks.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/ScheduleWorkPatternOddWeeks.md b/docs/models/ScheduleWorkPatternOddWeeks.md new file mode 100644 index 0000000000..0d197c8dce --- /dev/null +++ b/docs/models/ScheduleWorkPatternOddWeeks.md @@ -0,0 +1,18 @@ +# ScheduleWorkPatternOddWeeks + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**hours_monday** | **float** | | [optional] +**hours_tuesday** | **float** | | [optional] +**hours_wednesday** | **float** | | [optional] +**hours_thursday** | **float** | | [optional] +**hours_friday** | **float** | | [optional] +**hours_saturday** | **float** | | [optional] +**hours_sunday** | **float** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/ServiceCharge.md b/docs/models/ServiceCharge.md new file mode 100644 index 0000000000..d5b926136a --- /dev/null +++ b/docs/models/ServiceCharge.md @@ -0,0 +1,18 @@ +# ServiceCharge + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | | [optional] [readonly] +**name** | **str** | Service charge name | [optional] +**amount** | **float** | | [optional] +**percentage** | **float** | Service charge percentage. Use this field to calculate the amount of the service charge. Pass a percentage and amount at the same time. | [optional] +**currency** | [**Currency**](Currency.md) | | [optional] +**active** | **bool, none_type** | | [optional] +**type** | **str** | The type of the service charge. | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/ServiceCharges.md b/docs/models/ServiceCharges.md new file mode 100644 index 0000000000..ae53fbbd9b --- /dev/null +++ b/docs/models/ServiceCharges.md @@ -0,0 +1,12 @@ +# ServiceCharges + +Optional service charges or gratuity tip applied to the order. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | [**[ServiceCharge]**](ServiceCharge.md) | Optional service charges or gratuity tip applied to the order. | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/Session.md b/docs/models/Session.md new file mode 100644 index 0000000000..ba1db60f27 --- /dev/null +++ b/docs/models/Session.md @@ -0,0 +1,15 @@ +# Session + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**consumer_metadata** | [**ConsumerMetadata**](ConsumerMetadata.md) | | [optional] +**custom_consumer_settings** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | Custom consumer settings that are passed as part of the session. | [optional] +**redirect_uri** | **str** | | [optional] +**settings** | [**SessionSettings**](SessionSettings.md) | | [optional] +**theme** | [**SessionTheme**](SessionTheme.md) | | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/SessionSettings.md b/docs/models/SessionSettings.md new file mode 100644 index 0000000000..a487e8c9b5 --- /dev/null +++ b/docs/models/SessionSettings.md @@ -0,0 +1,20 @@ +# SessionSettings + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**unified_apis** | [**[UnifiedApiId]**](UnifiedApiId.md) | Provide the IDs of the Unified APIs you want to be visible. Leaving it empty or omiting this field will show all Unified APIs. | [optional] +**hide_resource_settings** | **bool** | | [optional] if omitted the server will use the default value of False +**sandbox_mode** | **bool** | Configure [Vault](/apis/vault/reference#section/Get-Started) to show a banner informing the logged in user is in a test environment. | [optional] if omitted the server will use the default value of False +**isolation_mode** | **bool** | Configure [Vault](/apis/vault/reference#section/Get-Started) to run in isolation mode, meaning it only shows the connection settings and hides the navigation items. | [optional] if omitted the server will use the default value of False +**session_length** | **str** | The duration of time the session is valid for (maximum 1 week). | [optional] if omitted the server will use the default value of "1h" +**show_logs** | **bool** | Configure [Vault](/apis/vault/reference#section/Get-Started) to show the logs page. Defaults to `true`. | [optional] if omitted the server will use the default value of True +**show_suggestions** | **bool** | Configure [Vault](/apis/vault/reference#section/Get-Started) to show the suggestions page. Defaults to `false`. | [optional] if omitted the server will use the default value of False +**show_sidebar** | **bool** | Configure [Vault](/apis/vault/reference#section/Get-Started) to show the sidebar. Defaults to `true`. | [optional] if omitted the server will use the default value of True +**auto_redirect** | **bool** | Automatically redirect to redirect uri after the connection has been configured as callable. Defaults to `false`. | [optional] if omitted the server will use the default value of False +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/SessionTheme.md b/docs/models/SessionTheme.md new file mode 100644 index 0000000000..765e6c514f --- /dev/null +++ b/docs/models/SessionTheme.md @@ -0,0 +1,18 @@ +# SessionTheme + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**favicon** | **str** | | [optional] +**primary_color** | **str** | | [optional] +**privacy_url** | **str** | | [optional] +**sidepanel_background_color** | **str** | | [optional] +**sidepanel_text_color** | **str** | | [optional] +**terms_url** | **str** | | [optional] +**vault_name** | **str** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/SharedLink.md b/docs/models/SharedLink.md new file mode 100644 index 0000000000..5a026c8fe9 --- /dev/null +++ b/docs/models/SharedLink.md @@ -0,0 +1,20 @@ +# SharedLink + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**target_id** | **str** | The ID of the file or folder to link. | +**url** | **str** | The URL that can be used to view the file. | [optional] [readonly] +**download_url** | **str** | The URL that can be used to download the file. | [optional] +**target** | [**SharedLinkTarget**](SharedLinkTarget.md) | | [optional] +**scope** | **str** | The scope of the shared link. | [optional] +**password_protected** | **bool** | Indicated if the shared link is password protected. | [optional] [readonly] +**password** | **str, none_type** | Optional password for the shared link. | [optional] +**expires_at** | **datetime** | | [optional] [readonly] +**updated_at** | **datetime** | | [optional] [readonly] +**created_at** | **datetime** | | [optional] [readonly] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/SharedLinkTarget.md b/docs/models/SharedLinkTarget.md new file mode 100644 index 0000000000..dc19df2788 --- /dev/null +++ b/docs/models/SharedLinkTarget.md @@ -0,0 +1,13 @@ +# SharedLinkTarget + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | | [readonly] +**name** | **str** | The name of the file | [optional] +**type** | [**FileType**](FileType.md) | | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/SimpleFormFieldOption.md b/docs/models/SimpleFormFieldOption.md new file mode 100644 index 0000000000..cfc36d218b --- /dev/null +++ b/docs/models/SimpleFormFieldOption.md @@ -0,0 +1,13 @@ +# SimpleFormFieldOption + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**label** | **str** | | [optional] +**value** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/SocialLink.md b/docs/models/SocialLink.md new file mode 100644 index 0000000000..fd6dec735c --- /dev/null +++ b/docs/models/SocialLink.md @@ -0,0 +1,13 @@ +# SocialLink + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**url** | **str** | | +**id** | **str, none_type** | | [optional] +**type** | **str, none_type** | | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/SortDirection.md b/docs/models/SortDirection.md new file mode 100644 index 0000000000..4948895d3a --- /dev/null +++ b/docs/models/SortDirection.md @@ -0,0 +1,12 @@ +# SortDirection + +The direction in which to sort the results + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **str** | The direction in which to sort the results | defaults to "asc", must be one of ["asc", "desc", ] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/Status.md b/docs/models/Status.md new file mode 100644 index 0000000000..455fd39da2 --- /dev/null +++ b/docs/models/Status.md @@ -0,0 +1,12 @@ +# Status + +The status of the webhook. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **str** | The status of the webhook. | must be one of ["enabled", "disabled", ] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/Supplier.md b/docs/models/Supplier.md new file mode 100644 index 0000000000..ba8187eff2 --- /dev/null +++ b/docs/models/Supplier.md @@ -0,0 +1,36 @@ +# Supplier + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | | [optional] [readonly] +**downstream_id** | **str, none_type** | The third-party API ID of original entity | [optional] [readonly] +**company_name** | **str, none_type** | | [optional] +**display_name** | **str, none_type** | Display name of supplier. | [optional] +**title** | **str, none_type** | | [optional] +**first_name** | **str, none_type** | | [optional] +**middle_name** | **str, none_type** | | [optional] +**last_name** | **str, none_type** | | [optional] +**suffix** | **str, none_type** | | [optional] +**addresses** | [**[Address]**](Address.md) | | [optional] +**notes** | **str, none_type** | | [optional] +**phone_numbers** | [**[PhoneNumber]**](PhoneNumber.md) | | [optional] +**emails** | [**[Email]**](Email.md) | | [optional] +**websites** | [**[Website]**](Website.md) | | [optional] +**bank_accounts** | [**[BankAccount]**](BankAccount.md) | | [optional] +**tax_rate** | [**LinkedTaxRate**](LinkedTaxRate.md) | | [optional] +**tax_number** | **str, none_type** | | [optional] +**currency** | [**Currency**](Currency.md) | | [optional] +**account** | [**LinkedLedgerAccount**](LinkedLedgerAccount.md) | | [optional] +**status** | **str, none_type** | Customer status | [optional] +**updated_by** | **str, none_type** | | [optional] [readonly] +**created_by** | **str, none_type** | | [optional] [readonly] +**updated_at** | **datetime** | | [optional] [readonly] +**created_at** | **datetime** | | [optional] [readonly] +**row_version** | **str, none_type** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/SupportedProperty.md b/docs/models/SupportedProperty.md new file mode 100644 index 0000000000..39a6097a27 --- /dev/null +++ b/docs/models/SupportedProperty.md @@ -0,0 +1,13 @@ +# SupportedProperty + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**unified_property** | **str** | Name of the property in our Unified API. | [optional] +**child_properties** | [**[SupportedPropertyChildProperties]**](SupportedPropertyChildProperties.md) | List of child properties of the unified property. | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/SupportedPropertyChildProperties.md b/docs/models/SupportedPropertyChildProperties.md new file mode 100644 index 0000000000..14e39eb8ad --- /dev/null +++ b/docs/models/SupportedPropertyChildProperties.md @@ -0,0 +1,12 @@ +# SupportedPropertyChildProperties + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**unified_property** | [**SupportedProperty**](SupportedProperty.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/Tags.md b/docs/models/Tags.md new file mode 100644 index 0000000000..d1a1558fd4 --- /dev/null +++ b/docs/models/Tags.md @@ -0,0 +1,11 @@ +# Tags + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **[str]** | | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/Tax.md b/docs/models/Tax.md new file mode 100644 index 0000000000..2578f3ac08 --- /dev/null +++ b/docs/models/Tax.md @@ -0,0 +1,14 @@ +# Tax + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | The name of the tax. | [optional] +**employer** | **bool** | Paid by employer. | [optional] +**amount** | **float** | The amount of the tax. | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/TaxRate.md b/docs/models/TaxRate.md new file mode 100644 index 0000000000..18bdeb9338 --- /dev/null +++ b/docs/models/TaxRate.md @@ -0,0 +1,28 @@ +# TaxRate + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str, none_type** | ID assigned to identify this tax rate. | [optional] +**name** | **str** | Name assigned to identify this tax rate. | [optional] +**code** | **str, none_type** | Tax code assigned to identify this tax rate. | [optional] +**description** | **str, none_type** | Description of tax rate | [optional] +**effective_tax_rate** | **float, none_type** | Effective tax rate | [optional] +**total_tax_rate** | **float, none_type** | Not compounded sum of the components of a tax rate | [optional] +**tax_payable_account_id** | **str, none_type** | Unique identifier for the account for tax collected. | [optional] +**tax_remitted_account_id** | **str, none_type** | Unique identifier for the account for tax remitted. | [optional] +**components** | **[bool, date, datetime, dict, float, int, list, str, none_type], none_type** | | [optional] +**type** | **str, none_type** | Tax type used to indicate the source of tax collected or paid | [optional] +**report_tax_type** | **str, none_type** | Report Tax type to aggregate tax collected or paid for reporting purposes | [optional] +**original_tax_rate_id** | **str, none_type** | ID of the original tax rate from which the new tax rate is derived. Helps to understand the relationship between corresponding tax rate entities. | [optional] +**status** | **str, none_type** | Tax rate status | [optional] +**row_version** | **str, none_type** | | [optional] +**updated_by** | **str, none_type** | | [optional] [readonly] +**created_by** | **str, none_type** | | [optional] [readonly] +**updated_at** | **datetime** | | [optional] [readonly] +**created_at** | **datetime** | | [optional] [readonly] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/TaxRatesFilter.md b/docs/models/TaxRatesFilter.md new file mode 100644 index 0000000000..507f1926a3 --- /dev/null +++ b/docs/models/TaxRatesFilter.md @@ -0,0 +1,15 @@ +# TaxRatesFilter + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**assets** | **bool** | Boolean to describe if tax rate can be used for asset accounts | [optional] +**equity** | **bool** | Boolean to describe if tax rate can be used for equity accounts | [optional] +**expenses** | **bool** | Boolean to describe if tax rate can be used for expense accounts | [optional] +**liabilities** | **bool** | Boolean to describe if tax rate can be used for liability accounts | [optional] +**revenue** | **bool** | Boolean to describe if tax rate can be used for revenue accounts | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/Tender.md b/docs/models/Tender.md new file mode 100644 index 0000000000..ac5d9ac4a8 --- /dev/null +++ b/docs/models/Tender.md @@ -0,0 +1,22 @@ +# Tender + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | | [optional] [readonly] +**key** | **str, none_type** | | [optional] +**label** | **str, none_type** | | [optional] +**active** | **bool, none_type** | | [optional] +**hidden** | **bool, none_type** | | [optional] +**editable** | **bool, none_type** | | [optional] +**opens_cash_drawer** | **bool** | If this tender opens the cash drawer | [optional] if omitted the server will use the default value of True +**allows_tipping** | **bool** | Allow tipping on payment from tender | [optional] if omitted the server will use the default value of True +**updated_by** | **str, none_type** | | [optional] [readonly] +**created_by** | **str, none_type** | | [optional] [readonly] +**updated_at** | **datetime** | | [optional] [readonly] +**created_at** | **datetime** | | [optional] [readonly] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/TimeOffRequest.md b/docs/models/TimeOffRequest.md new file mode 100644 index 0000000000..afb061f53f --- /dev/null +++ b/docs/models/TimeOffRequest.md @@ -0,0 +1,27 @@ +# TimeOffRequest + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | | [optional] [readonly] +**employee_id** | **str** | ID of the employee | [optional] +**policy_id** | **str** | ID of the policy | [optional] +**status** | **str** | The status of the time off request. | [optional] +**description** | **str** | Description of the time off request. | [optional] +**start_date** | **str** | The start date of the time off request. | [optional] +**end_date** | **str** | The end date of the time off request. | [optional] +**request_date** | **str** | The date the request was made. | [optional] +**request_type** | **str** | The type of request | [optional] +**approval_date** | **str** | The date the request was approved | [optional] +**units** | **str** | The unit of time off requested. Possible values include: `hours`, `days`, or `other`. | [optional] +**amount** | **float** | The amount of time off requested. | [optional] +**notes** | [**TimeOffRequestNotes**](TimeOffRequestNotes.md) | | [optional] +**updated_by** | **str, none_type** | | [optional] [readonly] +**created_by** | **str, none_type** | | [optional] [readonly] +**updated_at** | **datetime** | | [optional] [readonly] +**created_at** | **datetime** | | [optional] [readonly] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/TimeOffRequestNotes.md b/docs/models/TimeOffRequestNotes.md new file mode 100644 index 0000000000..f1b8533d5a --- /dev/null +++ b/docs/models/TimeOffRequestNotes.md @@ -0,0 +1,13 @@ +# TimeOffRequestNotes + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**employee** | **str** | | [optional] +**manager** | **str** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/TimeOffRequestsFilter.md b/docs/models/TimeOffRequestsFilter.md new file mode 100644 index 0000000000..00c31c31d5 --- /dev/null +++ b/docs/models/TimeOffRequestsFilter.md @@ -0,0 +1,14 @@ +# TimeOffRequestsFilter + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**start_date** | **str** | Start date | [optional] +**end_date** | **str** | End date | [optional] +**employee_id** | **str** | Employee ID | [optional] +**time_off_request_status** | **str** | Time off request status to filter on | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/TooManyRequestsResponse.md b/docs/models/TooManyRequestsResponse.md new file mode 100644 index 0000000000..7a57027f47 --- /dev/null +++ b/docs/models/TooManyRequestsResponse.md @@ -0,0 +1,17 @@ +# TooManyRequestsResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **float** | HTTP status code | [optional] +**error** | **str** | Contains an explanation of the status_code as defined in HTTP/1.1 standard (RFC 6585) | [optional] +**type_name** | **str** | The type of error returned | [optional] +**message** | **str** | A human-readable message providing more details about the error. | [optional] +**detail** | [**TooManyRequestsResponseDetail**](TooManyRequestsResponseDetail.md) | | [optional] +**ref** | **str** | Link to documentation of error type | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/TooManyRequestsResponseDetail.md b/docs/models/TooManyRequestsResponseDetail.md new file mode 100644 index 0000000000..6d07a67675 --- /dev/null +++ b/docs/models/TooManyRequestsResponseDetail.md @@ -0,0 +1,13 @@ +# TooManyRequestsResponseDetail + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**context** | **str** | | [optional] +**error** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/UnauthorizedResponse.md b/docs/models/UnauthorizedResponse.md new file mode 100644 index 0000000000..cd4829bd8c --- /dev/null +++ b/docs/models/UnauthorizedResponse.md @@ -0,0 +1,17 @@ +# UnauthorizedResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **float** | HTTP status code | [optional] +**error** | **str** | Contains an explanation of the status_code as defined in HTTP/1.1 standard (RFC 7231) | [optional] +**type_name** | **str** | The type of error returned | [optional] +**message** | **str** | A human-readable message providing more details about the error. | [optional] +**detail** | **str** | Contains parameter or domain specific information related to the error and why it occurred. | [optional] +**ref** | **str** | Link to documentation of error type | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/UnexpectedErrorResponse.md b/docs/models/UnexpectedErrorResponse.md new file mode 100644 index 0000000000..4555ced2d1 --- /dev/null +++ b/docs/models/UnexpectedErrorResponse.md @@ -0,0 +1,17 @@ +# UnexpectedErrorResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **float** | HTTP status code | [optional] +**error** | **str** | Contains an explanation of the status_code as defined in HTTP/1.1 standard (RFC 7231) | [optional] +**type_name** | **str** | The type of error returned | [optional] +**message** | **str** | A human-readable message providing more details about the error. | [optional] +**detail** | **bool, date, datetime, dict, float, int, list, str, none_type** | Contains parameter or domain specific information related to the error and why it occurred. | [optional] +**ref** | **str** | Link to documentation of error type | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/UnifiedApiId.md b/docs/models/UnifiedApiId.md new file mode 100644 index 0000000000..081493ae46 --- /dev/null +++ b/docs/models/UnifiedApiId.md @@ -0,0 +1,12 @@ +# UnifiedApiId + +Name of Apideck Unified API + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **str** | Name of Apideck Unified API | must be one of ["vault", "lead", "crm", "accounting", "file-storage", "spreadsheet", "email", "script", "sms", "team-messaging", "ecommerce", "payroll", "customer-support", "time-registration", "transactional-email", "form", "csp", "email-marketing", "ats", "hris", "pos", "project-management", "expense-management", "calendar", "procurement", ] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/UnifiedFile.md b/docs/models/UnifiedFile.md new file mode 100644 index 0000000000..7f1f881437 --- /dev/null +++ b/docs/models/UnifiedFile.md @@ -0,0 +1,26 @@ +# UnifiedFile + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | | [readonly] +**name** | **str** | The name of the file | +**type** | [**FileType**](FileType.md) | | +**downstream_id** | **str, none_type** | The third-party API ID of original entity | [optional] [readonly] +**description** | **str** | Optional description of the file | [optional] +**path** | **str** | The full path of the file or folder (includes the file name) | [optional] +**mime_type** | **str** | The MIME type of the file. | [optional] +**downloadable** | **bool** | Whether the current user can download this file | [optional] +**size** | **int** | The size of the file in bytes | [optional] +**owner** | [**Owner**](Owner.md) | | [optional] +**parent_folders** | [**[LinkedFolder]**](LinkedFolder.md) | The parent folders of the file, starting from the root | [optional] +**parent_folders_complete** | **bool** | Whether the list of parent folder is complete. Some connectors only return the direct parent of a file | [optional] +**updated_by** | **str, none_type** | | [optional] [readonly] +**created_by** | **str, none_type** | | [optional] [readonly] +**updated_at** | **datetime** | | [optional] [readonly] +**created_at** | **datetime** | | [optional] [readonly] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/UnifiedId.md b/docs/models/UnifiedId.md new file mode 100644 index 0000000000..07f6e0d7bb --- /dev/null +++ b/docs/models/UnifiedId.md @@ -0,0 +1,12 @@ +# UnifiedId + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | | [readonly] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/UnprocessableResponse.md b/docs/models/UnprocessableResponse.md new file mode 100644 index 0000000000..9a611a7018 --- /dev/null +++ b/docs/models/UnprocessableResponse.md @@ -0,0 +1,17 @@ +# UnprocessableResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **float** | HTTP status code | [optional] +**error** | **str** | Contains an explanation of the status_code as defined in HTTP/1.1 standard (RFC 7231) | [optional] +**type_name** | **str** | The type of error returned | [optional] +**message** | **str** | A human-readable message providing more details about the error. | [optional] +**detail** | **str** | Contains parameter or domain specific information related to the error and why it occurred. | [optional] +**ref** | **str** | Link to documentation of error type | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/UpdateActivityResponse.md b/docs/models/UpdateActivityResponse.md new file mode 100644 index 0000000000..35c5ca9627 --- /dev/null +++ b/docs/models/UpdateActivityResponse.md @@ -0,0 +1,17 @@ +# UpdateActivityResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedId**](UnifiedId.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/UpdateBillResponse.md b/docs/models/UpdateBillResponse.md new file mode 100644 index 0000000000..73ef6a7841 --- /dev/null +++ b/docs/models/UpdateBillResponse.md @@ -0,0 +1,17 @@ +# UpdateBillResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedId**](UnifiedId.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/UpdateCompanyResponse.md b/docs/models/UpdateCompanyResponse.md new file mode 100644 index 0000000000..ee6837de5f --- /dev/null +++ b/docs/models/UpdateCompanyResponse.md @@ -0,0 +1,17 @@ +# UpdateCompanyResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedId**](UnifiedId.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/UpdateConnectionResponse.md b/docs/models/UpdateConnectionResponse.md new file mode 100644 index 0000000000..62f4ebc4ae --- /dev/null +++ b/docs/models/UpdateConnectionResponse.md @@ -0,0 +1,14 @@ +# UpdateConnectionResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**data** | [**Connection**](Connection.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/UpdateContactResponse.md b/docs/models/UpdateContactResponse.md new file mode 100644 index 0000000000..22d2eb95d2 --- /dev/null +++ b/docs/models/UpdateContactResponse.md @@ -0,0 +1,17 @@ +# UpdateContactResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedId**](UnifiedId.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/UpdateCreditNoteResponse.md b/docs/models/UpdateCreditNoteResponse.md new file mode 100644 index 0000000000..42a0bc9716 --- /dev/null +++ b/docs/models/UpdateCreditNoteResponse.md @@ -0,0 +1,17 @@ +# UpdateCreditNoteResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedId**](UnifiedId.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/UpdateCustomerResponse.md b/docs/models/UpdateCustomerResponse.md new file mode 100644 index 0000000000..827368f150 --- /dev/null +++ b/docs/models/UpdateCustomerResponse.md @@ -0,0 +1,17 @@ +# UpdateCustomerResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedId**](UnifiedId.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/UpdateCustomerSupportCustomerResponse.md b/docs/models/UpdateCustomerSupportCustomerResponse.md new file mode 100644 index 0000000000..4d416f847e --- /dev/null +++ b/docs/models/UpdateCustomerSupportCustomerResponse.md @@ -0,0 +1,17 @@ +# UpdateCustomerSupportCustomerResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedId**](UnifiedId.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/UpdateDepartmentResponse.md b/docs/models/UpdateDepartmentResponse.md new file mode 100644 index 0000000000..6ef36cacb9 --- /dev/null +++ b/docs/models/UpdateDepartmentResponse.md @@ -0,0 +1,17 @@ +# UpdateDepartmentResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedId**](UnifiedId.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/UpdateDriveGroupResponse.md b/docs/models/UpdateDriveGroupResponse.md new file mode 100644 index 0000000000..8a2bc0feb0 --- /dev/null +++ b/docs/models/UpdateDriveGroupResponse.md @@ -0,0 +1,17 @@ +# UpdateDriveGroupResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedId**](UnifiedId.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/UpdateDriveResponse.md b/docs/models/UpdateDriveResponse.md new file mode 100644 index 0000000000..c2d3e13998 --- /dev/null +++ b/docs/models/UpdateDriveResponse.md @@ -0,0 +1,17 @@ +# UpdateDriveResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedId**](UnifiedId.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/UpdateEmployeeResponse.md b/docs/models/UpdateEmployeeResponse.md new file mode 100644 index 0000000000..9c9a15e70f --- /dev/null +++ b/docs/models/UpdateEmployeeResponse.md @@ -0,0 +1,17 @@ +# UpdateEmployeeResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedId**](UnifiedId.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/UpdateFileResponse.md b/docs/models/UpdateFileResponse.md new file mode 100644 index 0000000000..683a04ad98 --- /dev/null +++ b/docs/models/UpdateFileResponse.md @@ -0,0 +1,17 @@ +# UpdateFileResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedId**](UnifiedId.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/UpdateFolderRequest.md b/docs/models/UpdateFolderRequest.md new file mode 100644 index 0000000000..328339209a --- /dev/null +++ b/docs/models/UpdateFolderRequest.md @@ -0,0 +1,14 @@ +# UpdateFolderRequest + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | | [optional] [readonly] +**name** | **str** | The name of the folder. | [optional] +**description** | **str** | Optional description of the folder. | [optional] +**parent_folder_id** | **str** | The parent folder to create the new file within. | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/UpdateFolderResponse.md b/docs/models/UpdateFolderResponse.md new file mode 100644 index 0000000000..5bc20201c9 --- /dev/null +++ b/docs/models/UpdateFolderResponse.md @@ -0,0 +1,17 @@ +# UpdateFolderResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedId**](UnifiedId.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/UpdateHrisCompanyResponse.md b/docs/models/UpdateHrisCompanyResponse.md new file mode 100644 index 0000000000..d730e3daea --- /dev/null +++ b/docs/models/UpdateHrisCompanyResponse.md @@ -0,0 +1,17 @@ +# UpdateHrisCompanyResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedId**](UnifiedId.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/UpdateInvoiceItemsResponse.md b/docs/models/UpdateInvoiceItemsResponse.md new file mode 100644 index 0000000000..522f57c3bb --- /dev/null +++ b/docs/models/UpdateInvoiceItemsResponse.md @@ -0,0 +1,17 @@ +# UpdateInvoiceItemsResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedId**](UnifiedId.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/UpdateInvoiceResponse.md b/docs/models/UpdateInvoiceResponse.md new file mode 100644 index 0000000000..8cc9ef65bf --- /dev/null +++ b/docs/models/UpdateInvoiceResponse.md @@ -0,0 +1,17 @@ +# UpdateInvoiceResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**InvoiceResponse**](InvoiceResponse.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/UpdateItemResponse.md b/docs/models/UpdateItemResponse.md new file mode 100644 index 0000000000..3c8a1b1a83 --- /dev/null +++ b/docs/models/UpdateItemResponse.md @@ -0,0 +1,17 @@ +# UpdateItemResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedId**](UnifiedId.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/UpdateJobResponse.md b/docs/models/UpdateJobResponse.md new file mode 100644 index 0000000000..b9976feaba --- /dev/null +++ b/docs/models/UpdateJobResponse.md @@ -0,0 +1,17 @@ +# UpdateJobResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedId**](UnifiedId.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/UpdateLeadResponse.md b/docs/models/UpdateLeadResponse.md new file mode 100644 index 0000000000..8095400bcd --- /dev/null +++ b/docs/models/UpdateLeadResponse.md @@ -0,0 +1,17 @@ +# UpdateLeadResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedId**](UnifiedId.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/UpdateLedgerAccountResponse.md b/docs/models/UpdateLedgerAccountResponse.md new file mode 100644 index 0000000000..60eb69d9e6 --- /dev/null +++ b/docs/models/UpdateLedgerAccountResponse.md @@ -0,0 +1,17 @@ +# UpdateLedgerAccountResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedId**](UnifiedId.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/UpdateLocationResponse.md b/docs/models/UpdateLocationResponse.md new file mode 100644 index 0000000000..e96ad028c4 --- /dev/null +++ b/docs/models/UpdateLocationResponse.md @@ -0,0 +1,17 @@ +# UpdateLocationResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedId**](UnifiedId.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/UpdateMerchantResponse.md b/docs/models/UpdateMerchantResponse.md new file mode 100644 index 0000000000..a25906f9a0 --- /dev/null +++ b/docs/models/UpdateMerchantResponse.md @@ -0,0 +1,17 @@ +# UpdateMerchantResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedId**](UnifiedId.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/UpdateMessageResponse.md b/docs/models/UpdateMessageResponse.md new file mode 100644 index 0000000000..b93790b25e --- /dev/null +++ b/docs/models/UpdateMessageResponse.md @@ -0,0 +1,17 @@ +# UpdateMessageResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedId**](UnifiedId.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/UpdateModifierGroupResponse.md b/docs/models/UpdateModifierGroupResponse.md new file mode 100644 index 0000000000..608cb66162 --- /dev/null +++ b/docs/models/UpdateModifierGroupResponse.md @@ -0,0 +1,17 @@ +# UpdateModifierGroupResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedId**](UnifiedId.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/UpdateModifierResponse.md b/docs/models/UpdateModifierResponse.md new file mode 100644 index 0000000000..6143005474 --- /dev/null +++ b/docs/models/UpdateModifierResponse.md @@ -0,0 +1,17 @@ +# UpdateModifierResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedId**](UnifiedId.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/UpdateNoteResponse.md b/docs/models/UpdateNoteResponse.md new file mode 100644 index 0000000000..57b0f3c70f --- /dev/null +++ b/docs/models/UpdateNoteResponse.md @@ -0,0 +1,17 @@ +# UpdateNoteResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedId**](UnifiedId.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/UpdateOpportunityResponse.md b/docs/models/UpdateOpportunityResponse.md new file mode 100644 index 0000000000..9eda923db5 --- /dev/null +++ b/docs/models/UpdateOpportunityResponse.md @@ -0,0 +1,17 @@ +# UpdateOpportunityResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedId**](UnifiedId.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/UpdateOrderResponse.md b/docs/models/UpdateOrderResponse.md new file mode 100644 index 0000000000..41d50a827d --- /dev/null +++ b/docs/models/UpdateOrderResponse.md @@ -0,0 +1,17 @@ +# UpdateOrderResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedId**](UnifiedId.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/UpdateOrderTypeResponse.md b/docs/models/UpdateOrderTypeResponse.md new file mode 100644 index 0000000000..3287b944aa --- /dev/null +++ b/docs/models/UpdateOrderTypeResponse.md @@ -0,0 +1,17 @@ +# UpdateOrderTypeResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedId**](UnifiedId.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/UpdatePaymentResponse.md b/docs/models/UpdatePaymentResponse.md new file mode 100644 index 0000000000..caed7bdb59 --- /dev/null +++ b/docs/models/UpdatePaymentResponse.md @@ -0,0 +1,17 @@ +# UpdatePaymentResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedId**](UnifiedId.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/UpdatePipelineResponse.md b/docs/models/UpdatePipelineResponse.md new file mode 100644 index 0000000000..e9197b8d36 --- /dev/null +++ b/docs/models/UpdatePipelineResponse.md @@ -0,0 +1,17 @@ +# UpdatePipelineResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedId**](UnifiedId.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/UpdatePosPaymentResponse.md b/docs/models/UpdatePosPaymentResponse.md new file mode 100644 index 0000000000..da7d3f8264 --- /dev/null +++ b/docs/models/UpdatePosPaymentResponse.md @@ -0,0 +1,17 @@ +# UpdatePosPaymentResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedId**](UnifiedId.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/UpdateSharedLinkResponse.md b/docs/models/UpdateSharedLinkResponse.md new file mode 100644 index 0000000000..1f5ebb70eb --- /dev/null +++ b/docs/models/UpdateSharedLinkResponse.md @@ -0,0 +1,17 @@ +# UpdateSharedLinkResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedId**](UnifiedId.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/UpdateSupplierResponse.md b/docs/models/UpdateSupplierResponse.md new file mode 100644 index 0000000000..3370b305c1 --- /dev/null +++ b/docs/models/UpdateSupplierResponse.md @@ -0,0 +1,17 @@ +# UpdateSupplierResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedId**](UnifiedId.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/UpdateTaxRateResponse.md b/docs/models/UpdateTaxRateResponse.md new file mode 100644 index 0000000000..a445d8a326 --- /dev/null +++ b/docs/models/UpdateTaxRateResponse.md @@ -0,0 +1,17 @@ +# UpdateTaxRateResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedId**](UnifiedId.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/UpdateTenderResponse.md b/docs/models/UpdateTenderResponse.md new file mode 100644 index 0000000000..bc83bcb4e5 --- /dev/null +++ b/docs/models/UpdateTenderResponse.md @@ -0,0 +1,17 @@ +# UpdateTenderResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedId**](UnifiedId.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/UpdateTimeOffRequestResponse.md b/docs/models/UpdateTimeOffRequestResponse.md new file mode 100644 index 0000000000..ab7f0f23cf --- /dev/null +++ b/docs/models/UpdateTimeOffRequestResponse.md @@ -0,0 +1,17 @@ +# UpdateTimeOffRequestResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedId**](UnifiedId.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/UpdateUploadSessionResponse.md b/docs/models/UpdateUploadSessionResponse.md new file mode 100644 index 0000000000..9fadca2b27 --- /dev/null +++ b/docs/models/UpdateUploadSessionResponse.md @@ -0,0 +1,17 @@ +# UpdateUploadSessionResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedId**](UnifiedId.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/UpdateUserResponse.md b/docs/models/UpdateUserResponse.md new file mode 100644 index 0000000000..def48d31ca --- /dev/null +++ b/docs/models/UpdateUserResponse.md @@ -0,0 +1,17 @@ +# UpdateUserResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**service** | **str** | Apideck ID of service provider | +**resource** | **str** | Unified API resource name | +**operation** | **str** | Operation performed | +**data** | [**UnifiedId**](UnifiedId.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/UpdateWebhookRequest.md b/docs/models/UpdateWebhookRequest.md new file mode 100644 index 0000000000..4c2de61bdc --- /dev/null +++ b/docs/models/UpdateWebhookRequest.md @@ -0,0 +1,14 @@ +# UpdateWebhookRequest + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**description** | **str, none_type** | | [optional] +**status** | [**Status**](Status.md) | | [optional] +**delivery_url** | [**DeliveryUrl**](DeliveryUrl.md) | | [optional] +**events** | [**[WebhookEventType]**](WebhookEventType.md) | The list of subscribed events for this webhook. [`*`] indicates that all events are enabled. | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/UpdateWebhookResponse.md b/docs/models/UpdateWebhookResponse.md new file mode 100644 index 0000000000..145cb14601 --- /dev/null +++ b/docs/models/UpdateWebhookResponse.md @@ -0,0 +1,14 @@ +# UpdateWebhookResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status_code** | **int** | HTTP Response Status Code | +**status** | **str** | HTTP Response Status | +**data** | [**Webhook**](Webhook.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/UploadSession.md b/docs/models/UploadSession.md new file mode 100644 index 0000000000..2bb28be6cb --- /dev/null +++ b/docs/models/UploadSession.md @@ -0,0 +1,16 @@ +# UploadSession + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | | [optional] [readonly] +**success** | **bool** | Indicates if the upload session was completed successfully. | [optional] [readonly] +**part_size** | **float** | Size in bytes of each part of the file that you will upload. Uploaded parts need to be this size for the upload to be successful. | [optional] [readonly] +**parallel_upload_supported** | **bool** | Indicates if parts of the file can uploaded in parallel. | [optional] [readonly] +**uploaded_byte_range** | **str** | The range of bytes that was successfully uploaded. | [optional] [readonly] +**expires_at** | **datetime** | | [optional] [readonly] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/Url.md b/docs/models/Url.md new file mode 100644 index 0000000000..4047e30964 --- /dev/null +++ b/docs/models/Url.md @@ -0,0 +1,12 @@ +# Url + +The url pointing to the job. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **str** | The url pointing to the job. | + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/User.md b/docs/models/User.md new file mode 100644 index 0000000000..9d7e2d1cb6 --- /dev/null +++ b/docs/models/User.md @@ -0,0 +1,31 @@ +# User + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**emails** | [**[Email]**](Email.md) | | +**id** | **str** | | [optional] [readonly] +**parent_id** | **str, none_type** | | [optional] +**username** | **str, none_type** | | [optional] +**first_name** | **str, none_type** | | [optional] +**last_name** | **str, none_type** | | [optional] +**title** | **str, none_type** | | [optional] +**division** | **str, none_type** | The division the user is currently in. | [optional] +**department** | **str, none_type** | The department the user is currently in. | [optional] +**company_name** | **str, none_type** | | [optional] +**employee_number** | **str, none_type** | An Employee Number, Employee ID or Employee Code, is a unique number that has been assigned to each individual staff member within a company. | [optional] +**description** | **str, none_type** | | [optional] +**image** | **str, none_type** | | [optional] +**language** | **str, none_type** | language code according to ISO 639-1. For the United States - EN | [optional] +**status** | **str, none_type** | | [optional] +**password** | **str** | | [optional] +**addresses** | [**[Address]**](Address.md) | | [optional] +**phone_numbers** | [**[PhoneNumber]**](PhoneNumber.md) | | [optional] +**updated_at** | **str** | | [optional] [readonly] +**created_at** | **str** | | [optional] [readonly] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/VaultEventType.md b/docs/models/VaultEventType.md new file mode 100644 index 0000000000..64d93d2e1c --- /dev/null +++ b/docs/models/VaultEventType.md @@ -0,0 +1,11 @@ +# VaultEventType + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **str** | | must be one of ["*", "vault.connection.created", "vault.connection.updated", "vault.connection.disabled", "vault.connection.deleted", "vault.connection.callable", "vault.connection.token_refresh.failed", ] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/WalletDetails.md b/docs/models/WalletDetails.md new file mode 100644 index 0000000000..5037f301cc --- /dev/null +++ b/docs/models/WalletDetails.md @@ -0,0 +1,13 @@ +# WalletDetails + +Wallet details for this payment. This field is currently not available. Reach out to our team for more info. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status** | **str** | The status of the wallet payment. The status can be AUTHORIZED, CAPTURED, VOIDED, or FAILED. | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/Webhook.md b/docs/models/Webhook.md new file mode 100644 index 0000000000..865b5e8e52 --- /dev/null +++ b/docs/models/Webhook.md @@ -0,0 +1,19 @@ +# Webhook + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**unified_api** | [**UnifiedApiId**](UnifiedApiId.md) | | +**status** | [**Status**](Status.md) | | +**delivery_url** | [**DeliveryUrl**](DeliveryUrl.md) | | +**execute_base_url** | [**ExecuteBaseUrl**](ExecuteBaseUrl.md) | | +**events** | [**[WebhookEventType]**](WebhookEventType.md) | The list of subscribed events for this webhook. [`*`] indicates that all events are enabled. | +**id** | **str** | | [optional] [readonly] +**description** | **str, none_type** | | [optional] +**updated_at** | **datetime** | | [optional] [readonly] +**created_at** | **datetime** | | [optional] [readonly] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/WebhookEventLog.md b/docs/models/WebhookEventLog.md new file mode 100644 index 0000000000..997867a121 --- /dev/null +++ b/docs/models/WebhookEventLog.md @@ -0,0 +1,27 @@ +# WebhookEventLog + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | | [optional] +**status_code** | **int** | HTTP Status code that was returned. | [optional] +**success** | **bool** | Whether or not the request was successful. | [optional] +**application_id** | **str** | ID of your Apideck Application | [optional] +**consumer_id** | **str** | Consumer identifier | [optional] +**unified_api** | [**UnifiedApiId**](UnifiedApiId.md) | | [optional] +**service** | [**WebhookEventLogService**](WebhookEventLogService.md) | | [optional] +**endpoint** | **str** | The URL of the webhook endpoint. | [optional] +**event_type** | **str** | Name of source event that webhook is subscribed to. | [optional] +**execution_attempt** | **float** | Number of attempts webhook endpoint was called before a success was returned or eventually failed | [optional] +**http_method** | **str** | HTTP Method of request to endpoint. | [optional] +**timestamp** | **str** | ISO Date and time when the request was made. | [optional] +**entity_type** | **str** | Name of the Entity described by the attributes delivered within payload | [optional] +**request_body** | **str** | The JSON stringified payload that was delivered to the webhook endpoint. | [optional] +**response_body** | **str** | The JSON stringified response that was returned from the webhook endpoint. | [optional] +**retry_scheduled** | **bool** | If the request has not hit the max retry limit and will be retried. | [optional] +**attempts** | [**[WebhookEventLogAttempts]**](WebhookEventLogAttempts.md) | record of each attempt to call webhook endpoint | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/WebhookEventLogAttempts.md b/docs/models/WebhookEventLogAttempts.md new file mode 100644 index 0000000000..a5dd1bffdd --- /dev/null +++ b/docs/models/WebhookEventLogAttempts.md @@ -0,0 +1,15 @@ +# WebhookEventLogAttempts + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**timestamp** | **str** | ISO Date and time when the request was made. | [optional] +**execution_attempt** | **float** | Number of attempts webhook endpoint was called before a success was returned or eventually failed | [optional] +**status_code** | **int** | HTTP Status code that was returned. | [optional] +**success** | **bool** | Whether or not the request was successful. | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/WebhookEventLogService.md b/docs/models/WebhookEventLogService.md new file mode 100644 index 0000000000..31e81351e4 --- /dev/null +++ b/docs/models/WebhookEventLogService.md @@ -0,0 +1,14 @@ +# WebhookEventLogService + +Apideck service provider associated with event. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Apideck service provider id. | +**name** | **str** | Apideck service provider name. | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/WebhookEventLogsFilter.md b/docs/models/WebhookEventLogsFilter.md new file mode 100644 index 0000000000..4ea658304e --- /dev/null +++ b/docs/models/WebhookEventLogsFilter.md @@ -0,0 +1,16 @@ +# WebhookEventLogsFilter + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**exclude_apis** | **str, none_type** | | [optional] +**service** | [**WebhookEventLogsFilterService**](WebhookEventLogsFilterService.md) | | [optional] +**consumer_id** | **str, none_type** | | [optional] +**entity_type** | **str, none_type** | | [optional] +**event_type** | **str, none_type** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/WebhookEventLogsFilterService.md b/docs/models/WebhookEventLogsFilterService.md new file mode 100644 index 0000000000..3d0e036467 --- /dev/null +++ b/docs/models/WebhookEventLogsFilterService.md @@ -0,0 +1,12 @@ +# WebhookEventLogsFilterService + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/WebhookEventType.md b/docs/models/WebhookEventType.md new file mode 100644 index 0000000000..e5f61af142 --- /dev/null +++ b/docs/models/WebhookEventType.md @@ -0,0 +1,11 @@ +# WebhookEventType + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **str** | | must be one of ["*", "crm.activity.created", "crm.activity.updated", "crm.activity.deleted", "crm.company.created", "crm.company.updated", "crm.company.deleted", "crm.contact.created", "crm.contact.updated", "crm.contact.deleted", "crm.lead.created", "crm.lead.updated", "crm.lead.deleted", "crm.note.created", "crm.notes.updated", "crm.notes.deleted", "crm.opportunity.created", "crm.opportunity.updated", "crm.opportunity.deleted", "lead.lead.created", "lead.lead.updated", "lead.lead.deleted", "vault.connection.created", "vault.connection.updated", "vault.connection.disabled", "vault.connection.deleted", "vault.connection.callable", "vault.connection.token_refresh.failed", "ats.job.created", "ats.job.updated", "ats.job.deleted", "ats.applicant.created", "ats.applicant.updated", "ats.applicant.deleted", "accounting.customer.created", "accounting.customer.updated", "accounting.customer.deleted", "accounting.invoice.created", "accounting.invoice.updated", "accounting.invoice.deleted", "accounting.invoice_item.created", "accounting.invoice_item.updated", "accounting.invoice_item.deleted", "accounting.ledger_account.created", "accounting.ledger_account.updated", "accounting.ledger_account.deleted", "accounting.tax_rate.created", "accounting.tax_rate.updated", "accounting.tax_rate.deleted", "accounting.bill.created", "accounting.bill.updated", "accounting.bill.deleted", "accounting.payment.created", "accounting.payment.updated", "accounting.payment.deleted", "accounting.supplier.created", "accounting.supplier.updated", "accounting.supplier.deleted", "pos.order.created", "pos.order.updated", "pos.order.deleted", "pos.product.created", "pos.product.updated", "pos.product.deleted", "pos.payment.created", "pos.payment.updated", "pos.payment.deleted", "pos.merchant.created", "pos.merchant.updated", "pos.merchant.deleted", "pos.location.created", "pos.location.updated", "pos.location.deleted", "pos.item.created", "pos.item.updated", "pos.item.deleted", "pos.modifier.created", "pos.modifier.updated", "pos.modifier.deleted", "pos.modifier-group.created", "pos.modifier-group.updated", "pos.modifier-group.deleted", "hris.employee.created", "hris.employee.updated", "hris.employee.deleted", "hris.company.created", "hris.company.updated", "hris.company.deleted", "file-storage.file.created", "file-storage.file.updated", "file-storage.file.deleted", ] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/WebhookSubscription.md b/docs/models/WebhookSubscription.md new file mode 100644 index 0000000000..d2b84dbd2b --- /dev/null +++ b/docs/models/WebhookSubscription.md @@ -0,0 +1,15 @@ +# WebhookSubscription + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**downstream_id** | **str** | The ID of the downstream service | [optional] +**unify_event_types** | **[str]** | The list of Unify Events this connection is subscribed to | [optional] +**downstream_event_types** | **[str]** | The list of downstream Events this connection is subscribed to | [optional] +**execute_url** | **str** | The URL the downstream is sending to when the event is triggered | [optional] +**created_at** | **str** | The date and time the webhook subscription was created downstream | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/WebhookSupport.md b/docs/models/WebhookSupport.md new file mode 100644 index 0000000000..662f057c68 --- /dev/null +++ b/docs/models/WebhookSupport.md @@ -0,0 +1,14 @@ +# WebhookSupport + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**mode** | **str** | Mode of the webhook support. | [optional] +**subscription_level** | **str** | Received events are scoped to consumer or across integration. | [optional] +**managed_via** | **str** | How the subscription is managed in the downstream. | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/docs/models/Website.md b/docs/models/Website.md new file mode 100644 index 0000000000..8af1fa9272 --- /dev/null +++ b/docs/models/Website.md @@ -0,0 +1,13 @@ +# Website + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**url** | **str** | | +**id** | **str, none_type** | | [optional] +**type** | **str** | | [optional] + +[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md) + + diff --git a/package.json b/package.json new file mode 100644 index 0000000000..2d5bdae17d --- /dev/null +++ b/package.json @@ -0,0 +1,13 @@ +{ + "name": "@apideck/python", + "version": "0.0.1", + "description": "Apideck Python SDK", + "keywords": [ + "apideck", + "api", + "unify", + "unified apis" + ], + "homepage": "https://apideck.com", + "author": "Apideck (https://apideck.com/)" +} diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000000..8ea2a1c0a7 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,23 @@ +[build-system] +requires = ["setuptools>=61.0"] +build-backend = "setuptools.build_meta" + +[project] +name = "apideck" +version = "0.0.1" +authors = [ + { name="Apideck", email="support@apideck.com" }, +] +description = "Apideck Python SDK" +readme = "README.md" +requires-python = ">=3.7" +classifiers = [ + "Topic :: Software Development :: Libraries :: Python Modules", + "Programming Language :: Python :: 3", + "License :: OSI Approved :: Apache Software License", + "Operating System :: OS Independent", +] + +[project.urls] +"Homepage" = "https://apideck.com" +"Bug Tracker" = "https://github.com/apideck-libraries/python-sdk/issues" diff --git a/src/.gitignore b/src/.gitignore new file mode 100644 index 0000000000..43995bd42f --- /dev/null +++ b/src/.gitignore @@ -0,0 +1,66 @@ +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[cod] +*$py.class + +# C extensions +*.so + +# Distribution / packaging +.Python +env/ +build/ +develop-eggs/ +dist/ +downloads/ +eggs/ +.eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +*.egg-info/ +.installed.cfg +*.egg + +# PyInstaller +# Usually these files are written by a python script from a template +# before PyInstaller builds the exe, so as to inject date/other infos into it. +*.manifest +*.spec + +# Installer logs +pip-log.txt +pip-delete-this-directory.txt + +# Unit test / coverage reports +htmlcov/ +.tox/ +.coverage +.coverage.* +.cache +nosetests.xml +coverage.xml +*,cover +.hypothesis/ +venv/ +.venv/ +.python-version +.pytest_cache + +# Translations +*.mo +*.pot + +# Django stuff: +*.log + +# Sphinx documentation +docs/_build/ + +# PyBuilder +target/ + +#Ipython Notebook +.ipynb_checkpoints diff --git a/src/.gitlab-ci.yml b/src/.gitlab-ci.yml new file mode 100644 index 0000000000..99af450d79 --- /dev/null +++ b/src/.gitlab-ci.yml @@ -0,0 +1,24 @@ +# ref: https://docs.gitlab.com/ee/ci/README.html + +stages: + - test + +.tests: + stage: test + script: + - pip install -r requirements.txt + - pip install -r test-requirements.txt + - pytest --cov=apideck + +test-3.6: + extends: .tests + image: python:3.6-alpine +test-3.7: + extends: .tests + image: python:3.7-alpine +test-3.8: + extends: .tests + image: python:3.8-alpine +test-3.9: + extends: .tests + image: python:3.9-alpine diff --git a/src/.openapi-generator-ignore b/src/.openapi-generator-ignore new file mode 100644 index 0000000000..7484ee590a --- /dev/null +++ b/src/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/src/.openapi-generator/FILES b/src/.openapi-generator/FILES new file mode 100644 index 0000000000..63c359d1c2 --- /dev/null +++ b/src/.openapi-generator/FILES @@ -0,0 +1,1565 @@ +../.github/workflows/publish.yml +../.github/workflows/release.yml +../.github/workflows/test.yml +../.gitignore +../LICENSE +../README.md +../package.json +../pyproject.toml +.gitignore +.gitlab-ci.yml +.openapi-generator-ignore +.travis.yml +apideck/__init__.py +apideck/api/__init__.py +apideck/api/accounting_api.py +apideck/api/ats_api.py +apideck/api/connector_api.py +apideck/api/crm_api.py +apideck/api/customer_support_api.py +apideck/api/file_storage_api.py +apideck/api/hris_api.py +apideck/api/lead_api.py +apideck/api/pos_api.py +apideck/api/sms_api.py +apideck/api/vault_api.py +apideck/api/webhook_api.py +apideck/api_client.py +apideck/apis/__init__.py +apideck/configuration.py +apideck/exceptions.py +apideck/model/__init__.py +apideck/model/accounting_customer.py +apideck/model/accounting_event_type.py +apideck/model/activity.py +apideck/model/activity_attendee.py +apideck/model/address.py +apideck/model/api.py +apideck/model/api_resource.py +apideck/model/api_resource_coverage.py +apideck/model/api_resource_coverage_coverage.py +apideck/model/api_resource_linked_resources.py +apideck/model/api_resources.py +apideck/model/api_status.py +apideck/model/apis_filter.py +apideck/model/applicant.py +apideck/model/applicant_social_links.py +apideck/model/applicant_websites.py +apideck/model/applicants_filter.py +apideck/model/ats_activity.py +apideck/model/ats_event_type.py +apideck/model/auth_type.py +apideck/model/bad_request_response.py +apideck/model/balance_sheet.py +apideck/model/balance_sheet_assets.py +apideck/model/balance_sheet_assets_current_assets.py +apideck/model/balance_sheet_assets_current_assets_accounts.py +apideck/model/balance_sheet_assets_fixed_assets.py +apideck/model/balance_sheet_assets_fixed_assets_accounts.py +apideck/model/balance_sheet_equity.py +apideck/model/balance_sheet_equity_items.py +apideck/model/balance_sheet_filter.py +apideck/model/balance_sheet_liabilities.py +apideck/model/balance_sheet_liabilities_accounts.py +apideck/model/bank_account.py +apideck/model/benefit.py +apideck/model/bill.py +apideck/model/bill_line_item.py +apideck/model/branch.py +apideck/model/cash_details.py +apideck/model/companies_filter.py +apideck/model/companies_sort.py +apideck/model/company.py +apideck/model/company_info.py +apideck/model/company_row_type.py +apideck/model/compensation.py +apideck/model/connection.py +apideck/model/connection_configuration.py +apideck/model/connection_defaults.py +apideck/model/connection_import_data.py +apideck/model/connection_import_data_credentials.py +apideck/model/connection_metadata.py +apideck/model/connection_state.py +apideck/model/connection_webhook.py +apideck/model/connector.py +apideck/model/connector_doc.py +apideck/model/connector_event.py +apideck/model/connector_oauth_scopes.py +apideck/model/connector_oauth_scopes1.py +apideck/model/connector_resource.py +apideck/model/connector_setting.py +apideck/model/connector_status.py +apideck/model/connector_tls_support.py +apideck/model/connector_unified_apis.py +apideck/model/connectors_filter.py +apideck/model/consumer.py +apideck/model/consumer_connection.py +apideck/model/consumer_metadata.py +apideck/model/consumer_request_counts_in_date_range_response.py +apideck/model/consumer_request_counts_in_date_range_response_data.py +apideck/model/contact.py +apideck/model/contacts_filter.py +apideck/model/contacts_sort.py +apideck/model/copy_folder_request.py +apideck/model/create_activity_response.py +apideck/model/create_applicant_response.py +apideck/model/create_bill_response.py +apideck/model/create_company_response.py +apideck/model/create_connection_response.py +apideck/model/create_contact_response.py +apideck/model/create_credit_note_response.py +apideck/model/create_customer_response.py +apideck/model/create_customer_support_customer_response.py +apideck/model/create_department_response.py +apideck/model/create_drive_group_response.py +apideck/model/create_drive_response.py +apideck/model/create_employee_response.py +apideck/model/create_file_request.py +apideck/model/create_file_response.py +apideck/model/create_folder_request.py +apideck/model/create_folder_response.py +apideck/model/create_hris_company_response.py +apideck/model/create_invoice_item_response.py +apideck/model/create_invoice_response.py +apideck/model/create_item_response.py +apideck/model/create_job_response.py +apideck/model/create_lead_response.py +apideck/model/create_ledger_account_response.py +apideck/model/create_location_response.py +apideck/model/create_merchant_response.py +apideck/model/create_message_response.py +apideck/model/create_modifier_group_response.py +apideck/model/create_modifier_response.py +apideck/model/create_note_response.py +apideck/model/create_opportunity_response.py +apideck/model/create_order_response.py +apideck/model/create_order_type_response.py +apideck/model/create_payment_response.py +apideck/model/create_pipeline_response.py +apideck/model/create_pos_payment_response.py +apideck/model/create_session_response.py +apideck/model/create_session_response_data.py +apideck/model/create_shared_link_response.py +apideck/model/create_supplier_response.py +apideck/model/create_tax_rate_response.py +apideck/model/create_tender_response.py +apideck/model/create_time_off_request_response.py +apideck/model/create_upload_session_request.py +apideck/model/create_upload_session_response.py +apideck/model/create_user_response.py +apideck/model/create_webhook_request.py +apideck/model/create_webhook_response.py +apideck/model/credit_note.py +apideck/model/crm_event_type.py +apideck/model/currency.py +apideck/model/custom_field.py +apideck/model/customer_support_customer.py +apideck/model/customers_filter.py +apideck/model/deduction.py +apideck/model/delete_activity_response.py +apideck/model/delete_bill_response.py +apideck/model/delete_company_response.py +apideck/model/delete_contact_response.py +apideck/model/delete_credit_note_response.py +apideck/model/delete_customer_response.py +apideck/model/delete_customer_support_customer_response.py +apideck/model/delete_department_response.py +apideck/model/delete_drive_group_response.py +apideck/model/delete_drive_response.py +apideck/model/delete_employee_response.py +apideck/model/delete_file_response.py +apideck/model/delete_folder_response.py +apideck/model/delete_hris_company_response.py +apideck/model/delete_invoice_item_response.py +apideck/model/delete_invoice_response.py +apideck/model/delete_item_response.py +apideck/model/delete_job_response.py +apideck/model/delete_lead_response.py +apideck/model/delete_ledger_account_response.py +apideck/model/delete_location_response.py +apideck/model/delete_merchant_response.py +apideck/model/delete_message_response.py +apideck/model/delete_modifier_group_response.py +apideck/model/delete_modifier_response.py +apideck/model/delete_note_response.py +apideck/model/delete_opportunity_response.py +apideck/model/delete_order_response.py +apideck/model/delete_order_type_response.py +apideck/model/delete_payment_response.py +apideck/model/delete_pipeline_response.py +apideck/model/delete_pos_payment_response.py +apideck/model/delete_shared_link_response.py +apideck/model/delete_supplier_response.py +apideck/model/delete_tax_rate_response.py +apideck/model/delete_tender_response.py +apideck/model/delete_time_off_request_response.py +apideck/model/delete_upload_session_response.py +apideck/model/delete_user_response.py +apideck/model/delete_webhook_response.py +apideck/model/delivery_url.py +apideck/model/department.py +apideck/model/drive.py +apideck/model/drive_group.py +apideck/model/drive_groups_filter.py +apideck/model/drives_filter.py +apideck/model/email.py +apideck/model/employee.py +apideck/model/employee_compensations.py +apideck/model/employee_employment_role.py +apideck/model/employee_jobs.py +apideck/model/employee_manager.py +apideck/model/employee_partner.py +apideck/model/employee_payroll.py +apideck/model/employee_payrolls.py +apideck/model/employee_schedules.py +apideck/model/employee_team.py +apideck/model/employees_filter.py +apideck/model/error.py +apideck/model/execute_base_url.py +apideck/model/execute_webhook_event_request.py +apideck/model/execute_webhook_events_request.py +apideck/model/execute_webhook_response.py +apideck/model/file_storage_event_type.py +apideck/model/file_type.py +apideck/model/files_filter.py +apideck/model/files_search.py +apideck/model/files_sort.py +apideck/model/folder.py +apideck/model/form_field.py +apideck/model/form_field_option.py +apideck/model/form_field_option_group.py +apideck/model/gender.py +apideck/model/get_activities_response.py +apideck/model/get_activity_response.py +apideck/model/get_api_resource_coverage_response.py +apideck/model/get_api_resource_response.py +apideck/model/get_api_response.py +apideck/model/get_apis_response.py +apideck/model/get_applicant_response.py +apideck/model/get_applicants_response.py +apideck/model/get_balance_sheet_response.py +apideck/model/get_bill_response.py +apideck/model/get_bills_response.py +apideck/model/get_companies_response.py +apideck/model/get_company_info_response.py +apideck/model/get_company_response.py +apideck/model/get_connection_response.py +apideck/model/get_connections_response.py +apideck/model/get_connector_resource_response.py +apideck/model/get_connector_response.py +apideck/model/get_connectors_response.py +apideck/model/get_consumer_response.py +apideck/model/get_consumers_response.py +apideck/model/get_consumers_response_data.py +apideck/model/get_contact_response.py +apideck/model/get_contacts_response.py +apideck/model/get_credit_note_response.py +apideck/model/get_credit_notes_response.py +apideck/model/get_customer_response.py +apideck/model/get_customer_support_customer_response.py +apideck/model/get_customer_support_customers_response.py +apideck/model/get_customers_response.py +apideck/model/get_department_response.py +apideck/model/get_departments_response.py +apideck/model/get_drive_group_response.py +apideck/model/get_drive_groups_response.py +apideck/model/get_drive_response.py +apideck/model/get_drives_response.py +apideck/model/get_employee_payroll_response.py +apideck/model/get_employee_payrolls_response.py +apideck/model/get_employee_response.py +apideck/model/get_employee_schedules_response.py +apideck/model/get_employees_response.py +apideck/model/get_file_response.py +apideck/model/get_files_response.py +apideck/model/get_folder_response.py +apideck/model/get_folders_response.py +apideck/model/get_hris_companies_response.py +apideck/model/get_hris_company_response.py +apideck/model/get_hris_job_response.py +apideck/model/get_hris_jobs_response.py +apideck/model/get_invoice_item_response.py +apideck/model/get_invoice_items_response.py +apideck/model/get_invoice_response.py +apideck/model/get_invoices_response.py +apideck/model/get_item_response.py +apideck/model/get_items_response.py +apideck/model/get_job_response.py +apideck/model/get_jobs_response.py +apideck/model/get_lead_response.py +apideck/model/get_leads_response.py +apideck/model/get_ledger_account_response.py +apideck/model/get_ledger_accounts_response.py +apideck/model/get_location_response.py +apideck/model/get_locations_response.py +apideck/model/get_logs_response.py +apideck/model/get_merchant_response.py +apideck/model/get_merchants_response.py +apideck/model/get_message_response.py +apideck/model/get_messages_response.py +apideck/model/get_modifier_group_response.py +apideck/model/get_modifier_groups_response.py +apideck/model/get_modifier_response.py +apideck/model/get_modifiers_response.py +apideck/model/get_note_response.py +apideck/model/get_notes_response.py +apideck/model/get_opportunities_response.py +apideck/model/get_opportunity_response.py +apideck/model/get_order_response.py +apideck/model/get_order_type_response.py +apideck/model/get_order_types_response.py +apideck/model/get_orders_response.py +apideck/model/get_payment_response.py +apideck/model/get_payments_response.py +apideck/model/get_payroll_response.py +apideck/model/get_payrolls_response.py +apideck/model/get_pipeline_response.py +apideck/model/get_pipelines_response.py +apideck/model/get_pos_payment_response.py +apideck/model/get_pos_payments_response.py +apideck/model/get_profit_and_loss_response.py +apideck/model/get_shared_link_response.py +apideck/model/get_shared_links_response.py +apideck/model/get_supplier_response.py +apideck/model/get_suppliers_response.py +apideck/model/get_tax_rate_response.py +apideck/model/get_tax_rates_response.py +apideck/model/get_tender_response.py +apideck/model/get_tenders_response.py +apideck/model/get_time_off_request_response.py +apideck/model/get_time_off_requests_response.py +apideck/model/get_upload_session_response.py +apideck/model/get_user_response.py +apideck/model/get_users_response.py +apideck/model/get_webhook_event_logs_response.py +apideck/model/get_webhook_response.py +apideck/model/get_webhooks_response.py +apideck/model/hris_company.py +apideck/model/hris_event_type.py +apideck/model/hris_job.py +apideck/model/hris_job_location.py +apideck/model/hris_jobs.py +apideck/model/idempotency_key.py +apideck/model/invoice.py +apideck/model/invoice_item.py +apideck/model/invoice_item_asset_account.py +apideck/model/invoice_item_expense_account.py +apideck/model/invoice_item_income_account.py +apideck/model/invoice_item_sales_details.py +apideck/model/invoice_items_filter.py +apideck/model/invoice_line_item.py +apideck/model/invoice_response.py +apideck/model/invoices_sort.py +apideck/model/item.py +apideck/model/job.py +apideck/model/job_salary.py +apideck/model/job_status.py +apideck/model/jobs_filter.py +apideck/model/lead.py +apideck/model/lead_event_type.py +apideck/model/leads_filter.py +apideck/model/leads_sort.py +apideck/model/ledger_account.py +apideck/model/ledger_account_categories.py +apideck/model/ledger_account_parent_account.py +apideck/model/ledger_accounts.py +apideck/model/linked_connector_resource.py +apideck/model/linked_customer.py +apideck/model/linked_folder.py +apideck/model/linked_invoice_item.py +apideck/model/linked_ledger_account.py +apideck/model/linked_supplier.py +apideck/model/linked_tax_rate.py +apideck/model/links.py +apideck/model/location.py +apideck/model/log.py +apideck/model/log_operation.py +apideck/model/log_service.py +apideck/model/logs_filter.py +apideck/model/merchant.py +apideck/model/message.py +apideck/model/meta.py +apideck/model/meta_cursors.py +apideck/model/modifier.py +apideck/model/modifier_group.py +apideck/model/modifier_group_filter.py +apideck/model/not_found_response.py +apideck/model/not_implemented_response.py +apideck/model/note.py +apideck/model/o_auth_grant_type.py +apideck/model/offer.py +apideck/model/opportunities_filter.py +apideck/model/opportunities_sort.py +apideck/model/opportunity.py +apideck/model/order.py +apideck/model/order_customers.py +apideck/model/order_discounts.py +apideck/model/order_fulfillments.py +apideck/model/order_line_items.py +apideck/model/order_payments.py +apideck/model/order_pickup_details.py +apideck/model/order_pickup_details_curbside_pickup_details.py +apideck/model/order_pickup_details_recipient.py +apideck/model/order_refunds.py +apideck/model/order_tenders.py +apideck/model/order_type.py +apideck/model/owner.py +apideck/model/pagination_coverage.py +apideck/model/passthrough.py +apideck/model/payment.py +apideck/model/payment_allocations.py +apideck/model/payment_card.py +apideck/model/payment_required_response.py +apideck/model/payment_unit.py +apideck/model/payroll.py +apideck/model/payroll_totals.py +apideck/model/payrolls_filter.py +apideck/model/phone_number.py +apideck/model/pipeline.py +apideck/model/pipeline_stages.py +apideck/model/pos_bank_account.py +apideck/model/pos_bank_account_ach_details.py +apideck/model/pos_payment.py +apideck/model/pos_payment_card_details.py +apideck/model/pos_payment_external_details.py +apideck/model/price.py +apideck/model/profit_and_loss.py +apideck/model/profit_and_loss_expenses.py +apideck/model/profit_and_loss_filter.py +apideck/model/profit_and_loss_gross_profit.py +apideck/model/profit_and_loss_income.py +apideck/model/profit_and_loss_net_income.py +apideck/model/profit_and_loss_net_operating_income.py +apideck/model/profit_and_loss_record.py +apideck/model/profit_and_loss_records.py +apideck/model/profit_and_loss_section.py +apideck/model/request_count_allocation.py +apideck/model/resolve_webhook_event_request.py +apideck/model/resolve_webhook_events_request.py +apideck/model/resolve_webhook_response.py +apideck/model/resource_status.py +apideck/model/schedule.py +apideck/model/schedule_work_pattern.py +apideck/model/schedule_work_pattern_odd_weeks.py +apideck/model/service_charge.py +apideck/model/service_charges.py +apideck/model/session.py +apideck/model/session_settings.py +apideck/model/session_theme.py +apideck/model/shared_link.py +apideck/model/shared_link_target.py +apideck/model/simple_form_field_option.py +apideck/model/social_link.py +apideck/model/sort_direction.py +apideck/model/status.py +apideck/model/supplier.py +apideck/model/supported_property.py +apideck/model/supported_property_child_properties.py +apideck/model/tags.py +apideck/model/tax.py +apideck/model/tax_rate.py +apideck/model/tax_rates_filter.py +apideck/model/tender.py +apideck/model/time_off_request.py +apideck/model/time_off_request_notes.py +apideck/model/time_off_requests_filter.py +apideck/model/too_many_requests_response.py +apideck/model/too_many_requests_response_detail.py +apideck/model/unauthorized_response.py +apideck/model/unexpected_error_response.py +apideck/model/unified_api_id.py +apideck/model/unified_file.py +apideck/model/unified_id.py +apideck/model/unprocessable_response.py +apideck/model/update_activity_response.py +apideck/model/update_bill_response.py +apideck/model/update_company_response.py +apideck/model/update_connection_response.py +apideck/model/update_contact_response.py +apideck/model/update_credit_note_response.py +apideck/model/update_customer_response.py +apideck/model/update_customer_support_customer_response.py +apideck/model/update_department_response.py +apideck/model/update_drive_group_response.py +apideck/model/update_drive_response.py +apideck/model/update_employee_response.py +apideck/model/update_file_response.py +apideck/model/update_folder_request.py +apideck/model/update_folder_response.py +apideck/model/update_hris_company_response.py +apideck/model/update_invoice_items_response.py +apideck/model/update_invoice_response.py +apideck/model/update_item_response.py +apideck/model/update_job_response.py +apideck/model/update_lead_response.py +apideck/model/update_ledger_account_response.py +apideck/model/update_location_response.py +apideck/model/update_merchant_response.py +apideck/model/update_message_response.py +apideck/model/update_modifier_group_response.py +apideck/model/update_modifier_response.py +apideck/model/update_note_response.py +apideck/model/update_opportunity_response.py +apideck/model/update_order_response.py +apideck/model/update_order_type_response.py +apideck/model/update_payment_response.py +apideck/model/update_pipeline_response.py +apideck/model/update_pos_payment_response.py +apideck/model/update_shared_link_response.py +apideck/model/update_supplier_response.py +apideck/model/update_tax_rate_response.py +apideck/model/update_tender_response.py +apideck/model/update_time_off_request_response.py +apideck/model/update_upload_session_response.py +apideck/model/update_user_response.py +apideck/model/update_webhook_request.py +apideck/model/update_webhook_response.py +apideck/model/upload_session.py +apideck/model/url.py +apideck/model/user.py +apideck/model/vault_event_type.py +apideck/model/wallet_details.py +apideck/model/webhook.py +apideck/model/webhook_event_log.py +apideck/model/webhook_event_log_attempts.py +apideck/model/webhook_event_log_service.py +apideck/model/webhook_event_logs_filter.py +apideck/model/webhook_event_logs_filter_service.py +apideck/model/webhook_event_type.py +apideck/model/webhook_subscription.py +apideck/model/webhook_support.py +apideck/model/website.py +apideck/model_utils.py +apideck/models/__init__.py +apideck/rest.py +docs/AccountingApi.md +docs/AccountingCustomer.md +docs/AccountingEventType.md +docs/Activity.md +docs/ActivityAttendee.md +docs/Address.md +docs/Api.md +docs/ApiResource.md +docs/ApiResourceCoverage.md +docs/ApiResourceCoverageCoverage.md +docs/ApiResourceLinkedResources.md +docs/ApiResources.md +docs/ApiStatus.md +docs/ApisFilter.md +docs/Applicant.md +docs/ApplicantSocialLinks.md +docs/ApplicantWebsites.md +docs/ApplicantsFilter.md +docs/AtsActivity.md +docs/AtsApi.md +docs/AtsEventType.md +docs/AuthType.md +docs/BadRequestResponse.md +docs/BalanceSheet.md +docs/BalanceSheetAssets.md +docs/BalanceSheetAssetsCurrentAssets.md +docs/BalanceSheetAssetsCurrentAssetsAccounts.md +docs/BalanceSheetAssetsFixedAssets.md +docs/BalanceSheetAssetsFixedAssetsAccounts.md +docs/BalanceSheetEquity.md +docs/BalanceSheetEquityItems.md +docs/BalanceSheetFilter.md +docs/BalanceSheetLiabilities.md +docs/BalanceSheetLiabilitiesAccounts.md +docs/BankAccount.md +docs/Benefit.md +docs/Bill.md +docs/BillLineItem.md +docs/Branch.md +docs/CashDetails.md +docs/CompaniesFilter.md +docs/CompaniesSort.md +docs/Company.md +docs/CompanyInfo.md +docs/CompanyRowType.md +docs/Compensation.md +docs/Connection.md +docs/ConnectionConfiguration.md +docs/ConnectionDefaults.md +docs/ConnectionImportData.md +docs/ConnectionImportDataCredentials.md +docs/ConnectionMetadata.md +docs/ConnectionState.md +docs/ConnectionWebhook.md +docs/Connector.md +docs/ConnectorApi.md +docs/ConnectorDoc.md +docs/ConnectorEvent.md +docs/ConnectorOauthScopes.md +docs/ConnectorOauthScopes1.md +docs/ConnectorResource.md +docs/ConnectorSetting.md +docs/ConnectorStatus.md +docs/ConnectorTlsSupport.md +docs/ConnectorUnifiedApis.md +docs/ConnectorsFilter.md +docs/Consumer.md +docs/ConsumerConnection.md +docs/ConsumerMetadata.md +docs/ConsumerRequestCountsInDateRangeResponse.md +docs/ConsumerRequestCountsInDateRangeResponseData.md +docs/Contact.md +docs/ContactsFilter.md +docs/ContactsSort.md +docs/CopyFolderRequest.md +docs/CreateActivityResponse.md +docs/CreateApplicantResponse.md +docs/CreateBillResponse.md +docs/CreateCompanyResponse.md +docs/CreateConnectionResponse.md +docs/CreateContactResponse.md +docs/CreateCreditNoteResponse.md +docs/CreateCustomerResponse.md +docs/CreateCustomerSupportCustomerResponse.md +docs/CreateDepartmentResponse.md +docs/CreateDriveGroupResponse.md +docs/CreateDriveResponse.md +docs/CreateEmployeeResponse.md +docs/CreateFileRequest.md +docs/CreateFileResponse.md +docs/CreateFolderRequest.md +docs/CreateFolderResponse.md +docs/CreateHrisCompanyResponse.md +docs/CreateInvoiceItemResponse.md +docs/CreateInvoiceResponse.md +docs/CreateItemResponse.md +docs/CreateJobResponse.md +docs/CreateLeadResponse.md +docs/CreateLedgerAccountResponse.md +docs/CreateLocationResponse.md +docs/CreateMerchantResponse.md +docs/CreateMessageResponse.md +docs/CreateModifierGroupResponse.md +docs/CreateModifierResponse.md +docs/CreateNoteResponse.md +docs/CreateOpportunityResponse.md +docs/CreateOrderResponse.md +docs/CreateOrderTypeResponse.md +docs/CreatePaymentResponse.md +docs/CreatePipelineResponse.md +docs/CreatePosPaymentResponse.md +docs/CreateSessionResponse.md +docs/CreateSessionResponseData.md +docs/CreateSharedLinkResponse.md +docs/CreateSupplierResponse.md +docs/CreateTaxRateResponse.md +docs/CreateTenderResponse.md +docs/CreateTimeOffRequestResponse.md +docs/CreateUploadSessionRequest.md +docs/CreateUploadSessionResponse.md +docs/CreateUserResponse.md +docs/CreateWebhookRequest.md +docs/CreateWebhookResponse.md +docs/CreditNote.md +docs/CrmApi.md +docs/CrmEventType.md +docs/Currency.md +docs/CustomField.md +docs/CustomerSupportApi.md +docs/CustomerSupportCustomer.md +docs/CustomersFilter.md +docs/Deduction.md +docs/DeleteActivityResponse.md +docs/DeleteBillResponse.md +docs/DeleteCompanyResponse.md +docs/DeleteContactResponse.md +docs/DeleteCreditNoteResponse.md +docs/DeleteCustomerResponse.md +docs/DeleteCustomerSupportCustomerResponse.md +docs/DeleteDepartmentResponse.md +docs/DeleteDriveGroupResponse.md +docs/DeleteDriveResponse.md +docs/DeleteEmployeeResponse.md +docs/DeleteFileResponse.md +docs/DeleteFolderResponse.md +docs/DeleteHrisCompanyResponse.md +docs/DeleteInvoiceItemResponse.md +docs/DeleteInvoiceResponse.md +docs/DeleteItemResponse.md +docs/DeleteJobResponse.md +docs/DeleteLeadResponse.md +docs/DeleteLedgerAccountResponse.md +docs/DeleteLocationResponse.md +docs/DeleteMerchantResponse.md +docs/DeleteMessageResponse.md +docs/DeleteModifierGroupResponse.md +docs/DeleteModifierResponse.md +docs/DeleteNoteResponse.md +docs/DeleteOpportunityResponse.md +docs/DeleteOrderResponse.md +docs/DeleteOrderTypeResponse.md +docs/DeletePaymentResponse.md +docs/DeletePipelineResponse.md +docs/DeletePosPaymentResponse.md +docs/DeleteSharedLinkResponse.md +docs/DeleteSupplierResponse.md +docs/DeleteTaxRateResponse.md +docs/DeleteTenderResponse.md +docs/DeleteTimeOffRequestResponse.md +docs/DeleteUploadSessionResponse.md +docs/DeleteUserResponse.md +docs/DeleteWebhookResponse.md +docs/DeliveryUrl.md +docs/Department.md +docs/Drive.md +docs/DriveGroup.md +docs/DriveGroupsFilter.md +docs/DrivesFilter.md +docs/Email.md +docs/Employee.md +docs/EmployeeCompensations.md +docs/EmployeeEmploymentRole.md +docs/EmployeeJobs.md +docs/EmployeeManager.md +docs/EmployeePartner.md +docs/EmployeePayroll.md +docs/EmployeePayrolls.md +docs/EmployeeSchedules.md +docs/EmployeeTeam.md +docs/EmployeesFilter.md +docs/Error.md +docs/ExecuteBaseUrl.md +docs/ExecuteWebhookEventRequest.md +docs/ExecuteWebhookEventsRequest.md +docs/ExecuteWebhookResponse.md +docs/FileStorageApi.md +docs/FileStorageEventType.md +docs/FileType.md +docs/FilesFilter.md +docs/FilesSearch.md +docs/FilesSort.md +docs/Folder.md +docs/FormField.md +docs/FormFieldOption.md +docs/FormFieldOptionGroup.md +docs/Gender.md +docs/GetActivitiesResponse.md +docs/GetActivityResponse.md +docs/GetApiResourceCoverageResponse.md +docs/GetApiResourceResponse.md +docs/GetApiResponse.md +docs/GetApisResponse.md +docs/GetApplicantResponse.md +docs/GetApplicantsResponse.md +docs/GetBalanceSheetResponse.md +docs/GetBillResponse.md +docs/GetBillsResponse.md +docs/GetCompaniesResponse.md +docs/GetCompanyInfoResponse.md +docs/GetCompanyResponse.md +docs/GetConnectionResponse.md +docs/GetConnectionsResponse.md +docs/GetConnectorResourceResponse.md +docs/GetConnectorResponse.md +docs/GetConnectorsResponse.md +docs/GetConsumerResponse.md +docs/GetConsumersResponse.md +docs/GetConsumersResponseData.md +docs/GetContactResponse.md +docs/GetContactsResponse.md +docs/GetCreditNoteResponse.md +docs/GetCreditNotesResponse.md +docs/GetCustomerResponse.md +docs/GetCustomerSupportCustomerResponse.md +docs/GetCustomerSupportCustomersResponse.md +docs/GetCustomersResponse.md +docs/GetDepartmentResponse.md +docs/GetDepartmentsResponse.md +docs/GetDriveGroupResponse.md +docs/GetDriveGroupsResponse.md +docs/GetDriveResponse.md +docs/GetDrivesResponse.md +docs/GetEmployeePayrollResponse.md +docs/GetEmployeePayrollsResponse.md +docs/GetEmployeeResponse.md +docs/GetEmployeeSchedulesResponse.md +docs/GetEmployeesResponse.md +docs/GetFileResponse.md +docs/GetFilesResponse.md +docs/GetFolderResponse.md +docs/GetFoldersResponse.md +docs/GetHrisCompaniesResponse.md +docs/GetHrisCompanyResponse.md +docs/GetHrisJobResponse.md +docs/GetHrisJobsResponse.md +docs/GetInvoiceItemResponse.md +docs/GetInvoiceItemsResponse.md +docs/GetInvoiceResponse.md +docs/GetInvoicesResponse.md +docs/GetItemResponse.md +docs/GetItemsResponse.md +docs/GetJobResponse.md +docs/GetJobsResponse.md +docs/GetLeadResponse.md +docs/GetLeadsResponse.md +docs/GetLedgerAccountResponse.md +docs/GetLedgerAccountsResponse.md +docs/GetLocationResponse.md +docs/GetLocationsResponse.md +docs/GetLogsResponse.md +docs/GetMerchantResponse.md +docs/GetMerchantsResponse.md +docs/GetMessageResponse.md +docs/GetMessagesResponse.md +docs/GetModifierGroupResponse.md +docs/GetModifierGroupsResponse.md +docs/GetModifierResponse.md +docs/GetModifiersResponse.md +docs/GetNoteResponse.md +docs/GetNotesResponse.md +docs/GetOpportunitiesResponse.md +docs/GetOpportunityResponse.md +docs/GetOrderResponse.md +docs/GetOrderTypeResponse.md +docs/GetOrderTypesResponse.md +docs/GetOrdersResponse.md +docs/GetPaymentResponse.md +docs/GetPaymentsResponse.md +docs/GetPayrollResponse.md +docs/GetPayrollsResponse.md +docs/GetPipelineResponse.md +docs/GetPipelinesResponse.md +docs/GetPosPaymentResponse.md +docs/GetPosPaymentsResponse.md +docs/GetProfitAndLossResponse.md +docs/GetSharedLinkResponse.md +docs/GetSharedLinksResponse.md +docs/GetSupplierResponse.md +docs/GetSuppliersResponse.md +docs/GetTaxRateResponse.md +docs/GetTaxRatesResponse.md +docs/GetTenderResponse.md +docs/GetTendersResponse.md +docs/GetTimeOffRequestResponse.md +docs/GetTimeOffRequestsResponse.md +docs/GetUploadSessionResponse.md +docs/GetUserResponse.md +docs/GetUsersResponse.md +docs/GetWebhookEventLogsResponse.md +docs/GetWebhookResponse.md +docs/GetWebhooksResponse.md +docs/HrisApi.md +docs/HrisCompany.md +docs/HrisEventType.md +docs/HrisJob.md +docs/HrisJobLocation.md +docs/HrisJobs.md +docs/IdempotencyKey.md +docs/Invoice.md +docs/InvoiceItem.md +docs/InvoiceItemAssetAccount.md +docs/InvoiceItemExpenseAccount.md +docs/InvoiceItemIncomeAccount.md +docs/InvoiceItemSalesDetails.md +docs/InvoiceItemsFilter.md +docs/InvoiceLineItem.md +docs/InvoiceResponse.md +docs/InvoicesSort.md +docs/Item.md +docs/Job.md +docs/JobSalary.md +docs/JobStatus.md +docs/JobsFilter.md +docs/Lead.md +docs/LeadApi.md +docs/LeadEventType.md +docs/LeadsFilter.md +docs/LeadsSort.md +docs/LedgerAccount.md +docs/LedgerAccountCategories.md +docs/LedgerAccountParentAccount.md +docs/LedgerAccounts.md +docs/LinkedConnectorResource.md +docs/LinkedCustomer.md +docs/LinkedFolder.md +docs/LinkedInvoiceItem.md +docs/LinkedLedgerAccount.md +docs/LinkedSupplier.md +docs/LinkedTaxRate.md +docs/Links.md +docs/Location.md +docs/Log.md +docs/LogOperation.md +docs/LogService.md +docs/LogsFilter.md +docs/Merchant.md +docs/Message.md +docs/Meta.md +docs/MetaCursors.md +docs/Modifier.md +docs/ModifierGroup.md +docs/ModifierGroupFilter.md +docs/NotFoundResponse.md +docs/NotImplementedResponse.md +docs/Note.md +docs/OAuthGrantType.md +docs/Offer.md +docs/OpportunitiesFilter.md +docs/OpportunitiesSort.md +docs/Opportunity.md +docs/Order.md +docs/OrderCustomers.md +docs/OrderDiscounts.md +docs/OrderFulfillments.md +docs/OrderLineItems.md +docs/OrderPayments.md +docs/OrderPickupDetails.md +docs/OrderPickupDetailsCurbsidePickupDetails.md +docs/OrderPickupDetailsRecipient.md +docs/OrderRefunds.md +docs/OrderTenders.md +docs/OrderType.md +docs/Owner.md +docs/PaginationCoverage.md +docs/Passthrough.md +docs/Payment.md +docs/PaymentAllocations.md +docs/PaymentCard.md +docs/PaymentRequiredResponse.md +docs/PaymentUnit.md +docs/Payroll.md +docs/PayrollTotals.md +docs/PayrollsFilter.md +docs/PhoneNumber.md +docs/Pipeline.md +docs/PipelineStages.md +docs/PosApi.md +docs/PosBankAccount.md +docs/PosBankAccountAchDetails.md +docs/PosPayment.md +docs/PosPaymentCardDetails.md +docs/PosPaymentExternalDetails.md +docs/Price.md +docs/ProfitAndLoss.md +docs/ProfitAndLossExpenses.md +docs/ProfitAndLossFilter.md +docs/ProfitAndLossGrossProfit.md +docs/ProfitAndLossIncome.md +docs/ProfitAndLossNetIncome.md +docs/ProfitAndLossNetOperatingIncome.md +docs/ProfitAndLossRecord.md +docs/ProfitAndLossRecords.md +docs/ProfitAndLossSection.md +docs/RequestCountAllocation.md +docs/ResolveWebhookEventRequest.md +docs/ResolveWebhookEventsRequest.md +docs/ResolveWebhookResponse.md +docs/ResourceStatus.md +docs/Schedule.md +docs/ScheduleWorkPattern.md +docs/ScheduleWorkPatternOddWeeks.md +docs/ServiceCharge.md +docs/ServiceCharges.md +docs/Session.md +docs/SessionSettings.md +docs/SessionTheme.md +docs/SharedLink.md +docs/SharedLinkTarget.md +docs/SimpleFormFieldOption.md +docs/SmsApi.md +docs/SocialLink.md +docs/SortDirection.md +docs/Status.md +docs/Supplier.md +docs/SupportedProperty.md +docs/SupportedPropertyChildProperties.md +docs/Tags.md +docs/Tax.md +docs/TaxRate.md +docs/TaxRatesFilter.md +docs/Tender.md +docs/TimeOffRequest.md +docs/TimeOffRequestNotes.md +docs/TimeOffRequestsFilter.md +docs/TooManyRequestsResponse.md +docs/TooManyRequestsResponseDetail.md +docs/UnauthorizedResponse.md +docs/UnexpectedErrorResponse.md +docs/UnifiedApiId.md +docs/UnifiedFile.md +docs/UnifiedId.md +docs/UnprocessableResponse.md +docs/UpdateActivityResponse.md +docs/UpdateBillResponse.md +docs/UpdateCompanyResponse.md +docs/UpdateConnectionResponse.md +docs/UpdateContactResponse.md +docs/UpdateCreditNoteResponse.md +docs/UpdateCustomerResponse.md +docs/UpdateCustomerSupportCustomerResponse.md +docs/UpdateDepartmentResponse.md +docs/UpdateDriveGroupResponse.md +docs/UpdateDriveResponse.md +docs/UpdateEmployeeResponse.md +docs/UpdateFileResponse.md +docs/UpdateFolderRequest.md +docs/UpdateFolderResponse.md +docs/UpdateHrisCompanyResponse.md +docs/UpdateInvoiceItemsResponse.md +docs/UpdateInvoiceResponse.md +docs/UpdateItemResponse.md +docs/UpdateJobResponse.md +docs/UpdateLeadResponse.md +docs/UpdateLedgerAccountResponse.md +docs/UpdateLocationResponse.md +docs/UpdateMerchantResponse.md +docs/UpdateMessageResponse.md +docs/UpdateModifierGroupResponse.md +docs/UpdateModifierResponse.md +docs/UpdateNoteResponse.md +docs/UpdateOpportunityResponse.md +docs/UpdateOrderResponse.md +docs/UpdateOrderTypeResponse.md +docs/UpdatePaymentResponse.md +docs/UpdatePipelineResponse.md +docs/UpdatePosPaymentResponse.md +docs/UpdateSharedLinkResponse.md +docs/UpdateSupplierResponse.md +docs/UpdateTaxRateResponse.md +docs/UpdateTenderResponse.md +docs/UpdateTimeOffRequestResponse.md +docs/UpdateUploadSessionResponse.md +docs/UpdateUserResponse.md +docs/UpdateWebhookRequest.md +docs/UpdateWebhookResponse.md +docs/UploadSession.md +docs/Url.md +docs/User.md +docs/VaultApi.md +docs/VaultEventType.md +docs/WalletDetails.md +docs/Webhook.md +docs/WebhookApi.md +docs/WebhookEventLog.md +docs/WebhookEventLogAttempts.md +docs/WebhookEventLogService.md +docs/WebhookEventLogsFilter.md +docs/WebhookEventLogsFilterService.md +docs/WebhookEventType.md +docs/WebhookSubscription.md +docs/WebhookSupport.md +docs/Website.md +git_push.sh +requirements.txt +setup.cfg +setup.py +test-requirements.txt +test/__init__.py +test/test_accounting_api.py +test/test_accounting_customer.py +test/test_accounting_event_type.py +test/test_activity.py +test/test_activity_attendee.py +test/test_address.py +test/test_api.py +test/test_api_resource.py +test/test_api_resource_coverage.py +test/test_api_resource_coverage_coverage.py +test/test_api_resource_linked_resources.py +test/test_api_resources.py +test/test_api_status.py +test/test_apis_filter.py +test/test_applicant.py +test/test_applicant_social_links.py +test/test_applicant_websites.py +test/test_applicants_filter.py +test/test_ats_activity.py +test/test_ats_api.py +test/test_ats_event_type.py +test/test_auth_type.py +test/test_bad_request_response.py +test/test_balance_sheet.py +test/test_balance_sheet_assets.py +test/test_balance_sheet_assets_current_assets.py +test/test_balance_sheet_assets_current_assets_accounts.py +test/test_balance_sheet_assets_fixed_assets.py +test/test_balance_sheet_assets_fixed_assets_accounts.py +test/test_balance_sheet_equity.py +test/test_balance_sheet_equity_items.py +test/test_balance_sheet_filter.py +test/test_balance_sheet_liabilities.py +test/test_balance_sheet_liabilities_accounts.py +test/test_bank_account.py +test/test_benefit.py +test/test_bill.py +test/test_bill_line_item.py +test/test_branch.py +test/test_cash_details.py +test/test_companies_filter.py +test/test_companies_sort.py +test/test_company.py +test/test_company_info.py +test/test_company_row_type.py +test/test_compensation.py +test/test_connection.py +test/test_connection_configuration.py +test/test_connection_defaults.py +test/test_connection_import_data.py +test/test_connection_import_data_credentials.py +test/test_connection_metadata.py +test/test_connection_state.py +test/test_connection_webhook.py +test/test_connector.py +test/test_connector_api.py +test/test_connector_doc.py +test/test_connector_event.py +test/test_connector_oauth_scopes.py +test/test_connector_oauth_scopes1.py +test/test_connector_resource.py +test/test_connector_setting.py +test/test_connector_status.py +test/test_connector_tls_support.py +test/test_connector_unified_apis.py +test/test_connectors_filter.py +test/test_consumer.py +test/test_consumer_connection.py +test/test_consumer_metadata.py +test/test_consumer_request_counts_in_date_range_response.py +test/test_consumer_request_counts_in_date_range_response_data.py +test/test_contact.py +test/test_contacts_filter.py +test/test_contacts_sort.py +test/test_copy_folder_request.py +test/test_create_activity_response.py +test/test_create_applicant_response.py +test/test_create_bill_response.py +test/test_create_company_response.py +test/test_create_connection_response.py +test/test_create_contact_response.py +test/test_create_credit_note_response.py +test/test_create_customer_response.py +test/test_create_customer_support_customer_response.py +test/test_create_department_response.py +test/test_create_drive_group_response.py +test/test_create_drive_response.py +test/test_create_employee_response.py +test/test_create_file_request.py +test/test_create_file_response.py +test/test_create_folder_request.py +test/test_create_folder_response.py +test/test_create_hris_company_response.py +test/test_create_invoice_item_response.py +test/test_create_invoice_response.py +test/test_create_item_response.py +test/test_create_job_response.py +test/test_create_lead_response.py +test/test_create_ledger_account_response.py +test/test_create_location_response.py +test/test_create_merchant_response.py +test/test_create_message_response.py +test/test_create_modifier_group_response.py +test/test_create_modifier_response.py +test/test_create_note_response.py +test/test_create_opportunity_response.py +test/test_create_order_response.py +test/test_create_order_type_response.py +test/test_create_payment_response.py +test/test_create_pipeline_response.py +test/test_create_pos_payment_response.py +test/test_create_session_response.py +test/test_create_session_response_data.py +test/test_create_shared_link_response.py +test/test_create_supplier_response.py +test/test_create_tax_rate_response.py +test/test_create_tender_response.py +test/test_create_time_off_request_response.py +test/test_create_upload_session_request.py +test/test_create_upload_session_response.py +test/test_create_user_response.py +test/test_create_webhook_request.py +test/test_create_webhook_response.py +test/test_credit_note.py +test/test_crm_api.py +test/test_crm_event_type.py +test/test_currency.py +test/test_custom_field.py +test/test_customer_support_api.py +test/test_customer_support_customer.py +test/test_customers_filter.py +test/test_deduction.py +test/test_delete_activity_response.py +test/test_delete_bill_response.py +test/test_delete_company_response.py +test/test_delete_contact_response.py +test/test_delete_credit_note_response.py +test/test_delete_customer_response.py +test/test_delete_customer_support_customer_response.py +test/test_delete_department_response.py +test/test_delete_drive_group_response.py +test/test_delete_drive_response.py +test/test_delete_employee_response.py +test/test_delete_file_response.py +test/test_delete_folder_response.py +test/test_delete_hris_company_response.py +test/test_delete_invoice_item_response.py +test/test_delete_invoice_response.py +test/test_delete_item_response.py +test/test_delete_job_response.py +test/test_delete_lead_response.py +test/test_delete_ledger_account_response.py +test/test_delete_location_response.py +test/test_delete_merchant_response.py +test/test_delete_message_response.py +test/test_delete_modifier_group_response.py +test/test_delete_modifier_response.py +test/test_delete_note_response.py +test/test_delete_opportunity_response.py +test/test_delete_order_response.py +test/test_delete_order_type_response.py +test/test_delete_payment_response.py +test/test_delete_pipeline_response.py +test/test_delete_pos_payment_response.py +test/test_delete_shared_link_response.py +test/test_delete_supplier_response.py +test/test_delete_tax_rate_response.py +test/test_delete_tender_response.py +test/test_delete_time_off_request_response.py +test/test_delete_upload_session_response.py +test/test_delete_user_response.py +test/test_delete_webhook_response.py +test/test_delivery_url.py +test/test_department.py +test/test_drive.py +test/test_drive_group.py +test/test_drive_groups_filter.py +test/test_drives_filter.py +test/test_email.py +test/test_employee.py +test/test_employee_compensations.py +test/test_employee_employment_role.py +test/test_employee_jobs.py +test/test_employee_manager.py +test/test_employee_partner.py +test/test_employee_payroll.py +test/test_employee_payrolls.py +test/test_employee_schedules.py +test/test_employee_team.py +test/test_employees_filter.py +test/test_error.py +test/test_execute_base_url.py +test/test_execute_webhook_event_request.py +test/test_execute_webhook_events_request.py +test/test_execute_webhook_response.py +test/test_file_storage_api.py +test/test_file_storage_event_type.py +test/test_file_type.py +test/test_files_filter.py +test/test_files_search.py +test/test_files_sort.py +test/test_folder.py +test/test_form_field.py +test/test_form_field_option.py +test/test_form_field_option_group.py +test/test_gender.py +test/test_get_activities_response.py +test/test_get_activity_response.py +test/test_get_api_resource_coverage_response.py +test/test_get_api_resource_response.py +test/test_get_api_response.py +test/test_get_apis_response.py +test/test_get_applicant_response.py +test/test_get_applicants_response.py +test/test_get_balance_sheet_response.py +test/test_get_bill_response.py +test/test_get_bills_response.py +test/test_get_companies_response.py +test/test_get_company_info_response.py +test/test_get_company_response.py +test/test_get_connection_response.py +test/test_get_connections_response.py +test/test_get_connector_resource_response.py +test/test_get_connector_response.py +test/test_get_connectors_response.py +test/test_get_consumer_response.py +test/test_get_consumers_response.py +test/test_get_consumers_response_data.py +test/test_get_contact_response.py +test/test_get_contacts_response.py +test/test_get_credit_note_response.py +test/test_get_credit_notes_response.py +test/test_get_customer_response.py +test/test_get_customer_support_customer_response.py +test/test_get_customer_support_customers_response.py +test/test_get_customers_response.py +test/test_get_department_response.py +test/test_get_departments_response.py +test/test_get_drive_group_response.py +test/test_get_drive_groups_response.py +test/test_get_drive_response.py +test/test_get_drives_response.py +test/test_get_employee_payroll_response.py +test/test_get_employee_payrolls_response.py +test/test_get_employee_response.py +test/test_get_employee_schedules_response.py +test/test_get_employees_response.py +test/test_get_file_response.py +test/test_get_files_response.py +test/test_get_folder_response.py +test/test_get_folders_response.py +test/test_get_hris_companies_response.py +test/test_get_hris_company_response.py +test/test_get_hris_job_response.py +test/test_get_hris_jobs_response.py +test/test_get_invoice_item_response.py +test/test_get_invoice_items_response.py +test/test_get_invoice_response.py +test/test_get_invoices_response.py +test/test_get_item_response.py +test/test_get_items_response.py +test/test_get_job_response.py +test/test_get_jobs_response.py +test/test_get_lead_response.py +test/test_get_leads_response.py +test/test_get_ledger_account_response.py +test/test_get_ledger_accounts_response.py +test/test_get_location_response.py +test/test_get_locations_response.py +test/test_get_logs_response.py +test/test_get_merchant_response.py +test/test_get_merchants_response.py +test/test_get_message_response.py +test/test_get_messages_response.py +test/test_get_modifier_group_response.py +test/test_get_modifier_groups_response.py +test/test_get_modifier_response.py +test/test_get_modifiers_response.py +test/test_get_note_response.py +test/test_get_notes_response.py +test/test_get_opportunities_response.py +test/test_get_opportunity_response.py +test/test_get_order_response.py +test/test_get_order_type_response.py +test/test_get_order_types_response.py +test/test_get_orders_response.py +test/test_get_payment_response.py +test/test_get_payments_response.py +test/test_get_payroll_response.py +test/test_get_payrolls_response.py +test/test_get_pipeline_response.py +test/test_get_pipelines_response.py +test/test_get_pos_payment_response.py +test/test_get_pos_payments_response.py +test/test_get_profit_and_loss_response.py +test/test_get_shared_link_response.py +test/test_get_shared_links_response.py +test/test_get_supplier_response.py +test/test_get_suppliers_response.py +test/test_get_tax_rate_response.py +test/test_get_tax_rates_response.py +test/test_get_tender_response.py +test/test_get_tenders_response.py +test/test_get_time_off_request_response.py +test/test_get_time_off_requests_response.py +test/test_get_upload_session_response.py +test/test_get_user_response.py +test/test_get_users_response.py +test/test_get_webhook_event_logs_response.py +test/test_get_webhook_response.py +test/test_get_webhooks_response.py +test/test_hris_api.py +test/test_hris_company.py +test/test_hris_event_type.py +test/test_hris_job.py +test/test_hris_job_location.py +test/test_hris_jobs.py +test/test_idempotency_key.py +test/test_invoice.py +test/test_invoice_item.py +test/test_invoice_item_asset_account.py +test/test_invoice_item_expense_account.py +test/test_invoice_item_income_account.py +test/test_invoice_item_sales_details.py +test/test_invoice_items_filter.py +test/test_invoice_line_item.py +test/test_invoice_response.py +test/test_invoices_sort.py +test/test_item.py +test/test_job.py +test/test_job_salary.py +test/test_job_status.py +test/test_jobs_filter.py +test/test_lead.py +test/test_lead_api.py +test/test_lead_event_type.py +test/test_leads_filter.py +test/test_leads_sort.py +test/test_ledger_account.py +test/test_ledger_account_categories.py +test/test_ledger_account_parent_account.py +test/test_ledger_accounts.py +test/test_linked_connector_resource.py +test/test_linked_customer.py +test/test_linked_folder.py +test/test_linked_invoice_item.py +test/test_linked_ledger_account.py +test/test_linked_supplier.py +test/test_linked_tax_rate.py +test/test_links.py +test/test_location.py +test/test_log.py +test/test_log_operation.py +test/test_log_service.py +test/test_logs_filter.py +test/test_merchant.py +test/test_message.py +test/test_meta.py +test/test_meta_cursors.py +test/test_modifier.py +test/test_modifier_group.py +test/test_modifier_group_filter.py +test/test_not_found_response.py +test/test_not_implemented_response.py +test/test_note.py +test/test_o_auth_grant_type.py +test/test_offer.py +test/test_opportunities_filter.py +test/test_opportunities_sort.py +test/test_opportunity.py +test/test_order.py +test/test_order_customers.py +test/test_order_discounts.py +test/test_order_fulfillments.py +test/test_order_line_items.py +test/test_order_payments.py +test/test_order_pickup_details.py +test/test_order_pickup_details_curbside_pickup_details.py +test/test_order_pickup_details_recipient.py +test/test_order_refunds.py +test/test_order_tenders.py +test/test_order_type.py +test/test_owner.py +test/test_pagination_coverage.py +test/test_passthrough.py +test/test_payment.py +test/test_payment_allocations.py +test/test_payment_card.py +test/test_payment_required_response.py +test/test_payment_unit.py +test/test_payroll.py +test/test_payroll_totals.py +test/test_payrolls_filter.py +test/test_phone_number.py +test/test_pipeline.py +test/test_pipeline_stages.py +test/test_pos_api.py +test/test_pos_bank_account.py +test/test_pos_bank_account_ach_details.py +test/test_pos_payment.py +test/test_pos_payment_card_details.py +test/test_pos_payment_external_details.py +test/test_price.py +test/test_profit_and_loss.py +test/test_profit_and_loss_expenses.py +test/test_profit_and_loss_filter.py +test/test_profit_and_loss_gross_profit.py +test/test_profit_and_loss_income.py +test/test_profit_and_loss_net_income.py +test/test_profit_and_loss_net_operating_income.py +test/test_profit_and_loss_record.py +test/test_profit_and_loss_records.py +test/test_profit_and_loss_section.py +test/test_request_count_allocation.py +test/test_resolve_webhook_event_request.py +test/test_resolve_webhook_events_request.py +test/test_resolve_webhook_response.py +test/test_resource_status.py +test/test_schedule.py +test/test_schedule_work_pattern.py +test/test_schedule_work_pattern_odd_weeks.py +test/test_service_charge.py +test/test_service_charges.py +test/test_session.py +test/test_session_settings.py +test/test_session_theme.py +test/test_shared_link.py +test/test_shared_link_target.py +test/test_simple_form_field_option.py +test/test_sms_api.py +test/test_social_link.py +test/test_sort_direction.py +test/test_status.py +test/test_supplier.py +test/test_supported_property.py +test/test_supported_property_child_properties.py +test/test_tags.py +test/test_tax.py +test/test_tax_rate.py +test/test_tax_rates_filter.py +test/test_tender.py +test/test_time_off_request.py +test/test_time_off_request_notes.py +test/test_time_off_requests_filter.py +test/test_too_many_requests_response.py +test/test_too_many_requests_response_detail.py +test/test_unauthorized_response.py +test/test_unexpected_error_response.py +test/test_unified_api_id.py +test/test_unified_file.py +test/test_unified_id.py +test/test_unprocessable_response.py +test/test_update_activity_response.py +test/test_update_bill_response.py +test/test_update_company_response.py +test/test_update_connection_response.py +test/test_update_contact_response.py +test/test_update_credit_note_response.py +test/test_update_customer_response.py +test/test_update_customer_support_customer_response.py +test/test_update_department_response.py +test/test_update_drive_group_response.py +test/test_update_drive_response.py +test/test_update_employee_response.py +test/test_update_file_response.py +test/test_update_folder_request.py +test/test_update_folder_response.py +test/test_update_hris_company_response.py +test/test_update_invoice_items_response.py +test/test_update_invoice_response.py +test/test_update_item_response.py +test/test_update_job_response.py +test/test_update_lead_response.py +test/test_update_ledger_account_response.py +test/test_update_location_response.py +test/test_update_merchant_response.py +test/test_update_message_response.py +test/test_update_modifier_group_response.py +test/test_update_modifier_response.py +test/test_update_note_response.py +test/test_update_opportunity_response.py +test/test_update_order_response.py +test/test_update_order_type_response.py +test/test_update_payment_response.py +test/test_update_pipeline_response.py +test/test_update_pos_payment_response.py +test/test_update_shared_link_response.py +test/test_update_supplier_response.py +test/test_update_tax_rate_response.py +test/test_update_tender_response.py +test/test_update_time_off_request_response.py +test/test_update_upload_session_response.py +test/test_update_user_response.py +test/test_update_webhook_request.py +test/test_update_webhook_response.py +test/test_upload_session.py +test/test_url.py +test/test_user.py +test/test_vault_api.py +test/test_vault_event_type.py +test/test_wallet_details.py +test/test_webhook.py +test/test_webhook_api.py +test/test_webhook_event_log.py +test/test_webhook_event_log_attempts.py +test/test_webhook_event_log_service.py +test/test_webhook_event_logs_filter.py +test/test_webhook_event_logs_filter_service.py +test/test_webhook_event_type.py +test/test_webhook_subscription.py +test/test_webhook_support.py +test/test_website.py +tox.ini diff --git a/src/.openapi-generator/VERSION b/src/.openapi-generator/VERSION new file mode 100644 index 0000000000..1e20ec35c6 --- /dev/null +++ b/src/.openapi-generator/VERSION @@ -0,0 +1 @@ +5.4.0 \ No newline at end of file diff --git a/src/.travis.yml b/src/.travis.yml new file mode 100644 index 0000000000..390c2dd4ed --- /dev/null +++ b/src/.travis.yml @@ -0,0 +1,13 @@ +# ref: https://docs.travis-ci.com/user/languages/python +language: python +python: + - "3.6" + - "3.7" + - "3.8" + - "3.9" +# command to install dependencies +install: + - "pip install -r requirements.txt" + - "pip install -r test-requirements.txt" +# command to run tests +script: pytest --cov=apideck diff --git a/src/apideck/__init__.py b/src/apideck/__init__.py new file mode 100644 index 0000000000..4e6d81fec1 --- /dev/null +++ b/src/apideck/__init__.py @@ -0,0 +1,27 @@ +# flake8: noqa + +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +__version__ = "0.0.1" + +# import ApiClient +from apideck.api_client import ApiClient + +# import Configuration +from apideck.configuration import Configuration + +# import exceptions +from apideck.exceptions import OpenApiException +from apideck.exceptions import ApiAttributeError +from apideck.exceptions import ApiTypeError +from apideck.exceptions import ApiValueError +from apideck.exceptions import ApiKeyError +from apideck.exceptions import ApiException diff --git a/src/apideck/api/__init__.py b/src/apideck/api/__init__.py new file mode 100644 index 0000000000..21408b957e --- /dev/null +++ b/src/apideck/api/__init__.py @@ -0,0 +1,3 @@ +# do not import all apis into this module because that uses a lot of memory and stack frames +# if you need the ability to import all apis from one package, import them with +# from apideck.apis import AccountingApi diff --git a/src/apideck/api/accounting_api.py b/src/apideck/api/accounting_api.py new file mode 100644 index 0000000000..0ddc11d5c3 --- /dev/null +++ b/src/apideck/api/accounting_api.py @@ -0,0 +1,7627 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.api_client import ApiClient, Endpoint as _Endpoint +from apideck.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) +from apideck.model.accounting_customer import AccountingCustomer +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.balance_sheet_filter import BalanceSheetFilter +from apideck.model.bill import Bill +from apideck.model.create_bill_response import CreateBillResponse +from apideck.model.create_credit_note_response import CreateCreditNoteResponse +from apideck.model.create_customer_response import CreateCustomerResponse +from apideck.model.create_invoice_item_response import CreateInvoiceItemResponse +from apideck.model.create_invoice_response import CreateInvoiceResponse +from apideck.model.create_ledger_account_response import CreateLedgerAccountResponse +from apideck.model.create_payment_response import CreatePaymentResponse +from apideck.model.create_supplier_response import CreateSupplierResponse +from apideck.model.create_tax_rate_response import CreateTaxRateResponse +from apideck.model.credit_note import CreditNote +from apideck.model.customers_filter import CustomersFilter +from apideck.model.delete_bill_response import DeleteBillResponse +from apideck.model.delete_credit_note_response import DeleteCreditNoteResponse +from apideck.model.delete_customer_response import DeleteCustomerResponse +from apideck.model.delete_invoice_response import DeleteInvoiceResponse +from apideck.model.delete_ledger_account_response import DeleteLedgerAccountResponse +from apideck.model.delete_payment_response import DeletePaymentResponse +from apideck.model.delete_supplier_response import DeleteSupplierResponse +from apideck.model.delete_tax_rate_response import DeleteTaxRateResponse +from apideck.model.get_balance_sheet_response import GetBalanceSheetResponse +from apideck.model.get_bill_response import GetBillResponse +from apideck.model.get_bills_response import GetBillsResponse +from apideck.model.get_company_info_response import GetCompanyInfoResponse +from apideck.model.get_credit_note_response import GetCreditNoteResponse +from apideck.model.get_credit_notes_response import GetCreditNotesResponse +from apideck.model.get_customer_response import GetCustomerResponse +from apideck.model.get_customers_response import GetCustomersResponse +from apideck.model.get_invoice_item_response import GetInvoiceItemResponse +from apideck.model.get_invoice_items_response import GetInvoiceItemsResponse +from apideck.model.get_invoice_response import GetInvoiceResponse +from apideck.model.get_invoices_response import GetInvoicesResponse +from apideck.model.get_ledger_account_response import GetLedgerAccountResponse +from apideck.model.get_ledger_accounts_response import GetLedgerAccountsResponse +from apideck.model.get_payment_response import GetPaymentResponse +from apideck.model.get_payments_response import GetPaymentsResponse +from apideck.model.get_profit_and_loss_response import GetProfitAndLossResponse +from apideck.model.get_supplier_response import GetSupplierResponse +from apideck.model.get_suppliers_response import GetSuppliersResponse +from apideck.model.get_tax_rate_response import GetTaxRateResponse +from apideck.model.get_tax_rates_response import GetTaxRatesResponse +from apideck.model.invoice import Invoice +from apideck.model.invoice_item import InvoiceItem +from apideck.model.invoice_items_filter import InvoiceItemsFilter +from apideck.model.invoices_sort import InvoicesSort +from apideck.model.ledger_account import LedgerAccount +from apideck.model.not_found_response import NotFoundResponse +from apideck.model.passthrough import Passthrough +from apideck.model.payment import Payment +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.profit_and_loss_filter import ProfitAndLossFilter +from apideck.model.supplier import Supplier +from apideck.model.tax_rate import TaxRate +from apideck.model.tax_rates_filter import TaxRatesFilter +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.update_bill_response import UpdateBillResponse +from apideck.model.update_credit_note_response import UpdateCreditNoteResponse +from apideck.model.update_customer_response import UpdateCustomerResponse +from apideck.model.update_invoice_items_response import UpdateInvoiceItemsResponse +from apideck.model.update_invoice_response import UpdateInvoiceResponse +from apideck.model.update_ledger_account_response import UpdateLedgerAccountResponse +from apideck.model.update_payment_response import UpdatePaymentResponse +from apideck.model.update_supplier_response import UpdateSupplierResponse +from apideck.model.update_tax_rate_response import UpdateTaxRateResponse + + +class AccountingApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.balance_sheet_one_endpoint = _Endpoint( + settings={ + 'response_type': (GetBalanceSheetResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/accounting/balance-sheet', + 'operation_id': 'balance_sheet_one', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'consumer_id', + 'app_id', + 'service_id', + 'pass_through', + 'filter', + 'raw', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'pass_through': + (Passthrough,), + 'filter': + (BalanceSheetFilter,), + 'raw': + (bool,), + }, + 'attribute_map': { + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'pass_through': 'pass_through', + 'filter': 'filter', + 'raw': 'raw', + }, + 'location_map': { + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'pass_through': 'query', + 'filter': 'query', + 'raw': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.bills_add_endpoint = _Endpoint( + settings={ + 'response_type': (CreateBillResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/accounting/bills', + 'operation_id': 'bills_add', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'bill', + 'raw', + 'consumer_id', + 'app_id', + 'service_id', + ], + 'required': [ + 'bill', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'bill': + (Bill,), + 'raw': + (bool,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + }, + 'attribute_map': { + 'raw': 'raw', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + }, + 'location_map': { + 'bill': 'body', + 'raw': 'query', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.bills_all_endpoint = _Endpoint( + settings={ + 'response_type': (GetBillsResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/accounting/bills', + 'operation_id': 'bills_all', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'raw', + 'consumer_id', + 'app_id', + 'service_id', + 'cursor', + 'limit', + ], + 'required': [], + 'nullable': [ + 'cursor', + ], + 'enum': [ + ], + 'validation': [ + 'limit', + ] + }, + root_map={ + 'validations': { + ('limit',): { + + 'inclusive_maximum': 200, + 'inclusive_minimum': 1, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'raw': + (bool,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'cursor': + (str, none_type,), + 'limit': + (int,), + }, + 'attribute_map': { + 'raw': 'raw', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'cursor': 'cursor', + 'limit': 'limit', + }, + 'location_map': { + 'raw': 'query', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'cursor': 'query', + 'limit': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.bills_delete_endpoint = _Endpoint( + settings={ + 'response_type': (DeleteBillResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/accounting/bills/{id}', + 'operation_id': 'bills_delete', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + }, + 'location_map': { + 'id': 'path', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.bills_one_endpoint = _Endpoint( + settings={ + 'response_type': (GetBillResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/accounting/bills/{id}', + 'operation_id': 'bills_one', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + }, + 'location_map': { + 'id': 'path', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.bills_update_endpoint = _Endpoint( + settings={ + 'response_type': (UpdateBillResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/accounting/bills/{id}', + 'operation_id': 'bills_update', + 'http_method': 'PATCH', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'bill', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + ], + 'required': [ + 'id', + 'bill', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'bill': + (Bill,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + }, + 'location_map': { + 'id': 'path', + 'bill': 'body', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.company_info_one_endpoint = _Endpoint( + settings={ + 'response_type': (GetCompanyInfoResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/accounting/company-info', + 'operation_id': 'company_info_one', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'raw', + 'consumer_id', + 'app_id', + 'service_id', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'raw': + (bool,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + }, + 'attribute_map': { + 'raw': 'raw', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + }, + 'location_map': { + 'raw': 'query', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.credit_notes_add_endpoint = _Endpoint( + settings={ + 'response_type': (CreateCreditNoteResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/accounting/credit-notes', + 'operation_id': 'credit_notes_add', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'credit_note', + 'raw', + 'consumer_id', + 'app_id', + 'service_id', + ], + 'required': [ + 'credit_note', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'credit_note': + (CreditNote,), + 'raw': + (bool,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + }, + 'attribute_map': { + 'raw': 'raw', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + }, + 'location_map': { + 'credit_note': 'body', + 'raw': 'query', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.credit_notes_all_endpoint = _Endpoint( + settings={ + 'response_type': (GetCreditNotesResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/accounting/credit-notes', + 'operation_id': 'credit_notes_all', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'raw', + 'consumer_id', + 'app_id', + 'service_id', + 'cursor', + 'limit', + ], + 'required': [], + 'nullable': [ + 'cursor', + ], + 'enum': [ + ], + 'validation': [ + 'limit', + ] + }, + root_map={ + 'validations': { + ('limit',): { + + 'inclusive_maximum': 200, + 'inclusive_minimum': 1, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'raw': + (bool,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'cursor': + (str, none_type,), + 'limit': + (int,), + }, + 'attribute_map': { + 'raw': 'raw', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'cursor': 'cursor', + 'limit': 'limit', + }, + 'location_map': { + 'raw': 'query', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'cursor': 'query', + 'limit': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.credit_notes_delete_endpoint = _Endpoint( + settings={ + 'response_type': (DeleteCreditNoteResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/accounting/credit-notes/{id}', + 'operation_id': 'credit_notes_delete', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + }, + 'location_map': { + 'id': 'path', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.credit_notes_one_endpoint = _Endpoint( + settings={ + 'response_type': (GetCreditNoteResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/accounting/credit-notes/{id}', + 'operation_id': 'credit_notes_one', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + }, + 'location_map': { + 'id': 'path', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.credit_notes_update_endpoint = _Endpoint( + settings={ + 'response_type': (UpdateCreditNoteResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/accounting/credit-notes/{id}', + 'operation_id': 'credit_notes_update', + 'http_method': 'PATCH', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'credit_note', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + ], + 'required': [ + 'id', + 'credit_note', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'credit_note': + (CreditNote,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + }, + 'location_map': { + 'id': 'path', + 'credit_note': 'body', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.customers_add_endpoint = _Endpoint( + settings={ + 'response_type': (CreateCustomerResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/accounting/customers', + 'operation_id': 'customers_add', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'accounting_customer', + 'raw', + 'consumer_id', + 'app_id', + 'service_id', + ], + 'required': [ + 'accounting_customer', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'accounting_customer': + (AccountingCustomer,), + 'raw': + (bool,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + }, + 'attribute_map': { + 'raw': 'raw', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + }, + 'location_map': { + 'accounting_customer': 'body', + 'raw': 'query', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.customers_all_endpoint = _Endpoint( + settings={ + 'response_type': (GetCustomersResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/accounting/customers', + 'operation_id': 'customers_all', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'raw', + 'consumer_id', + 'app_id', + 'service_id', + 'cursor', + 'limit', + 'filter', + ], + 'required': [], + 'nullable': [ + 'cursor', + ], + 'enum': [ + ], + 'validation': [ + 'limit', + ] + }, + root_map={ + 'validations': { + ('limit',): { + + 'inclusive_maximum': 200, + 'inclusive_minimum': 1, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'raw': + (bool,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'cursor': + (str, none_type,), + 'limit': + (int,), + 'filter': + (CustomersFilter,), + }, + 'attribute_map': { + 'raw': 'raw', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'cursor': 'cursor', + 'limit': 'limit', + 'filter': 'filter', + }, + 'location_map': { + 'raw': 'query', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'cursor': 'query', + 'limit': 'query', + 'filter': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.customers_delete_endpoint = _Endpoint( + settings={ + 'response_type': (DeleteCustomerResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/accounting/customers/{id}', + 'operation_id': 'customers_delete', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + }, + 'location_map': { + 'id': 'path', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.customers_one_endpoint = _Endpoint( + settings={ + 'response_type': (GetCustomerResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/accounting/customers/{id}', + 'operation_id': 'customers_one', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + }, + 'location_map': { + 'id': 'path', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.customers_update_endpoint = _Endpoint( + settings={ + 'response_type': (UpdateCustomerResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/accounting/customers/{id}', + 'operation_id': 'customers_update', + 'http_method': 'PATCH', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'accounting_customer', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + ], + 'required': [ + 'id', + 'accounting_customer', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'accounting_customer': + (AccountingCustomer,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + }, + 'location_map': { + 'id': 'path', + 'accounting_customer': 'body', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.invoice_items_add_endpoint = _Endpoint( + settings={ + 'response_type': (CreateInvoiceItemResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/accounting/invoice-items', + 'operation_id': 'invoice_items_add', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'invoice_item', + 'raw', + 'consumer_id', + 'app_id', + 'service_id', + ], + 'required': [ + 'invoice_item', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'invoice_item': + (InvoiceItem,), + 'raw': + (bool,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + }, + 'attribute_map': { + 'raw': 'raw', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + }, + 'location_map': { + 'invoice_item': 'body', + 'raw': 'query', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.invoice_items_all_endpoint = _Endpoint( + settings={ + 'response_type': (GetInvoiceItemsResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/accounting/invoice-items', + 'operation_id': 'invoice_items_all', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'raw', + 'consumer_id', + 'app_id', + 'service_id', + 'cursor', + 'limit', + 'filter', + ], + 'required': [], + 'nullable': [ + 'cursor', + ], + 'enum': [ + ], + 'validation': [ + 'limit', + ] + }, + root_map={ + 'validations': { + ('limit',): { + + 'inclusive_maximum': 200, + 'inclusive_minimum': 1, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'raw': + (bool,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'cursor': + (str, none_type,), + 'limit': + (int,), + 'filter': + (InvoiceItemsFilter,), + }, + 'attribute_map': { + 'raw': 'raw', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'cursor': 'cursor', + 'limit': 'limit', + 'filter': 'filter', + }, + 'location_map': { + 'raw': 'query', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'cursor': 'query', + 'limit': 'query', + 'filter': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.invoice_items_delete_endpoint = _Endpoint( + settings={ + 'response_type': (DeleteTaxRateResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/accounting/invoice-items/{id}', + 'operation_id': 'invoice_items_delete', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + }, + 'location_map': { + 'id': 'path', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.invoice_items_one_endpoint = _Endpoint( + settings={ + 'response_type': (GetInvoiceItemResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/accounting/invoice-items/{id}', + 'operation_id': 'invoice_items_one', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + }, + 'location_map': { + 'id': 'path', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.invoice_items_update_endpoint = _Endpoint( + settings={ + 'response_type': (UpdateInvoiceItemsResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/accounting/invoice-items/{id}', + 'operation_id': 'invoice_items_update', + 'http_method': 'PATCH', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'invoice_item', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + ], + 'required': [ + 'id', + 'invoice_item', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'invoice_item': + (InvoiceItem,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + }, + 'location_map': { + 'id': 'path', + 'invoice_item': 'body', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.invoices_add_endpoint = _Endpoint( + settings={ + 'response_type': (CreateInvoiceResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/accounting/invoices', + 'operation_id': 'invoices_add', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'invoice', + 'raw', + 'consumer_id', + 'app_id', + 'service_id', + ], + 'required': [ + 'invoice', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'invoice': + (Invoice,), + 'raw': + (bool,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + }, + 'attribute_map': { + 'raw': 'raw', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + }, + 'location_map': { + 'invoice': 'body', + 'raw': 'query', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.invoices_all_endpoint = _Endpoint( + settings={ + 'response_type': (GetInvoicesResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/accounting/invoices', + 'operation_id': 'invoices_all', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'raw', + 'consumer_id', + 'app_id', + 'service_id', + 'cursor', + 'limit', + 'sort', + ], + 'required': [], + 'nullable': [ + 'cursor', + ], + 'enum': [ + ], + 'validation': [ + 'limit', + ] + }, + root_map={ + 'validations': { + ('limit',): { + + 'inclusive_maximum': 200, + 'inclusive_minimum': 1, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'raw': + (bool,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'cursor': + (str, none_type,), + 'limit': + (int,), + 'sort': + (InvoicesSort,), + }, + 'attribute_map': { + 'raw': 'raw', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'cursor': 'cursor', + 'limit': 'limit', + 'sort': 'sort', + }, + 'location_map': { + 'raw': 'query', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'cursor': 'query', + 'limit': 'query', + 'sort': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.invoices_delete_endpoint = _Endpoint( + settings={ + 'response_type': (DeleteInvoiceResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/accounting/invoices/{id}', + 'operation_id': 'invoices_delete', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + }, + 'location_map': { + 'id': 'path', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.invoices_one_endpoint = _Endpoint( + settings={ + 'response_type': (GetInvoiceResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/accounting/invoices/{id}', + 'operation_id': 'invoices_one', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + }, + 'location_map': { + 'id': 'path', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.invoices_update_endpoint = _Endpoint( + settings={ + 'response_type': (UpdateInvoiceResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/accounting/invoices/{id}', + 'operation_id': 'invoices_update', + 'http_method': 'PATCH', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'invoice', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + ], + 'required': [ + 'id', + 'invoice', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'invoice': + (Invoice,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + }, + 'location_map': { + 'id': 'path', + 'invoice': 'body', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.ledger_accounts_add_endpoint = _Endpoint( + settings={ + 'response_type': (CreateLedgerAccountResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/accounting/ledger-accounts', + 'operation_id': 'ledger_accounts_add', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'ledger_account', + 'raw', + 'consumer_id', + 'app_id', + 'service_id', + ], + 'required': [ + 'ledger_account', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'ledger_account': + (LedgerAccount,), + 'raw': + (bool,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + }, + 'attribute_map': { + 'raw': 'raw', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + }, + 'location_map': { + 'ledger_account': 'body', + 'raw': 'query', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.ledger_accounts_all_endpoint = _Endpoint( + settings={ + 'response_type': (GetLedgerAccountsResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/accounting/ledger-accounts', + 'operation_id': 'ledger_accounts_all', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'raw', + 'consumer_id', + 'app_id', + 'service_id', + 'cursor', + 'limit', + ], + 'required': [], + 'nullable': [ + 'cursor', + ], + 'enum': [ + ], + 'validation': [ + 'limit', + ] + }, + root_map={ + 'validations': { + ('limit',): { + + 'inclusive_maximum': 200, + 'inclusive_minimum': 1, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'raw': + (bool,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'cursor': + (str, none_type,), + 'limit': + (int,), + }, + 'attribute_map': { + 'raw': 'raw', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'cursor': 'cursor', + 'limit': 'limit', + }, + 'location_map': { + 'raw': 'query', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'cursor': 'query', + 'limit': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.ledger_accounts_delete_endpoint = _Endpoint( + settings={ + 'response_type': (DeleteLedgerAccountResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/accounting/ledger-accounts/{id}', + 'operation_id': 'ledger_accounts_delete', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + }, + 'location_map': { + 'id': 'path', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.ledger_accounts_one_endpoint = _Endpoint( + settings={ + 'response_type': (GetLedgerAccountResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/accounting/ledger-accounts/{id}', + 'operation_id': 'ledger_accounts_one', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + }, + 'location_map': { + 'id': 'path', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.ledger_accounts_update_endpoint = _Endpoint( + settings={ + 'response_type': (UpdateLedgerAccountResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/accounting/ledger-accounts/{id}', + 'operation_id': 'ledger_accounts_update', + 'http_method': 'PATCH', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'ledger_account', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + ], + 'required': [ + 'id', + 'ledger_account', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'ledger_account': + (LedgerAccount,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + }, + 'location_map': { + 'id': 'path', + 'ledger_account': 'body', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.payments_add_endpoint = _Endpoint( + settings={ + 'response_type': (CreatePaymentResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/accounting/payments', + 'operation_id': 'payments_add', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'payment', + 'raw', + 'consumer_id', + 'app_id', + 'service_id', + ], + 'required': [ + 'payment', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'payment': + (Payment,), + 'raw': + (bool,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + }, + 'attribute_map': { + 'raw': 'raw', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + }, + 'location_map': { + 'payment': 'body', + 'raw': 'query', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.payments_all_endpoint = _Endpoint( + settings={ + 'response_type': (GetPaymentsResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/accounting/payments', + 'operation_id': 'payments_all', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'raw', + 'consumer_id', + 'app_id', + 'service_id', + 'cursor', + 'limit', + ], + 'required': [], + 'nullable': [ + 'cursor', + ], + 'enum': [ + ], + 'validation': [ + 'limit', + ] + }, + root_map={ + 'validations': { + ('limit',): { + + 'inclusive_maximum': 200, + 'inclusive_minimum': 1, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'raw': + (bool,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'cursor': + (str, none_type,), + 'limit': + (int,), + }, + 'attribute_map': { + 'raw': 'raw', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'cursor': 'cursor', + 'limit': 'limit', + }, + 'location_map': { + 'raw': 'query', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'cursor': 'query', + 'limit': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.payments_delete_endpoint = _Endpoint( + settings={ + 'response_type': (DeletePaymentResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/accounting/payments/{id}', + 'operation_id': 'payments_delete', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + }, + 'location_map': { + 'id': 'path', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.payments_one_endpoint = _Endpoint( + settings={ + 'response_type': (GetPaymentResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/accounting/payments/{id}', + 'operation_id': 'payments_one', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + }, + 'location_map': { + 'id': 'path', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.payments_update_endpoint = _Endpoint( + settings={ + 'response_type': (UpdatePaymentResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/accounting/payments/{id}', + 'operation_id': 'payments_update', + 'http_method': 'PATCH', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'payment', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + ], + 'required': [ + 'id', + 'payment', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'payment': + (Payment,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + }, + 'location_map': { + 'id': 'path', + 'payment': 'body', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.profit_and_loss_one_endpoint = _Endpoint( + settings={ + 'response_type': (GetProfitAndLossResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/accounting/profit-and-loss', + 'operation_id': 'profit_and_loss_one', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'raw', + 'consumer_id', + 'app_id', + 'service_id', + 'filter', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'raw': + (bool,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'filter': + (ProfitAndLossFilter,), + }, + 'attribute_map': { + 'raw': 'raw', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'filter': 'filter', + }, + 'location_map': { + 'raw': 'query', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'filter': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.suppliers_add_endpoint = _Endpoint( + settings={ + 'response_type': (CreateSupplierResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/accounting/suppliers', + 'operation_id': 'suppliers_add', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'supplier', + 'raw', + 'consumer_id', + 'app_id', + 'service_id', + ], + 'required': [ + 'supplier', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'supplier': + (Supplier,), + 'raw': + (bool,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + }, + 'attribute_map': { + 'raw': 'raw', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + }, + 'location_map': { + 'supplier': 'body', + 'raw': 'query', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.suppliers_all_endpoint = _Endpoint( + settings={ + 'response_type': (GetSuppliersResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/accounting/suppliers', + 'operation_id': 'suppliers_all', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'raw', + 'consumer_id', + 'app_id', + 'service_id', + 'cursor', + 'limit', + ], + 'required': [], + 'nullable': [ + 'cursor', + ], + 'enum': [ + ], + 'validation': [ + 'limit', + ] + }, + root_map={ + 'validations': { + ('limit',): { + + 'inclusive_maximum': 200, + 'inclusive_minimum': 1, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'raw': + (bool,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'cursor': + (str, none_type,), + 'limit': + (int,), + }, + 'attribute_map': { + 'raw': 'raw', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'cursor': 'cursor', + 'limit': 'limit', + }, + 'location_map': { + 'raw': 'query', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'cursor': 'query', + 'limit': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.suppliers_delete_endpoint = _Endpoint( + settings={ + 'response_type': (DeleteSupplierResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/accounting/suppliers/{id}', + 'operation_id': 'suppliers_delete', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + }, + 'location_map': { + 'id': 'path', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.suppliers_one_endpoint = _Endpoint( + settings={ + 'response_type': (GetSupplierResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/accounting/suppliers/{id}', + 'operation_id': 'suppliers_one', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + }, + 'location_map': { + 'id': 'path', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.suppliers_update_endpoint = _Endpoint( + settings={ + 'response_type': (UpdateSupplierResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/accounting/suppliers/{id}', + 'operation_id': 'suppliers_update', + 'http_method': 'PATCH', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'supplier', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + ], + 'required': [ + 'id', + 'supplier', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'supplier': + (Supplier,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + }, + 'location_map': { + 'id': 'path', + 'supplier': 'body', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.tax_rates_add_endpoint = _Endpoint( + settings={ + 'response_type': (CreateTaxRateResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/accounting/tax-rates', + 'operation_id': 'tax_rates_add', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'tax_rate', + 'raw', + 'consumer_id', + 'app_id', + 'service_id', + ], + 'required': [ + 'tax_rate', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'tax_rate': + (TaxRate,), + 'raw': + (bool,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + }, + 'attribute_map': { + 'raw': 'raw', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + }, + 'location_map': { + 'tax_rate': 'body', + 'raw': 'query', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.tax_rates_all_endpoint = _Endpoint( + settings={ + 'response_type': (GetTaxRatesResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/accounting/tax-rates', + 'operation_id': 'tax_rates_all', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'raw', + 'consumer_id', + 'app_id', + 'service_id', + 'cursor', + 'limit', + 'filter', + ], + 'required': [], + 'nullable': [ + 'cursor', + ], + 'enum': [ + ], + 'validation': [ + 'limit', + ] + }, + root_map={ + 'validations': { + ('limit',): { + + 'inclusive_maximum': 200, + 'inclusive_minimum': 1, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'raw': + (bool,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'cursor': + (str, none_type,), + 'limit': + (int,), + 'filter': + (TaxRatesFilter,), + }, + 'attribute_map': { + 'raw': 'raw', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'cursor': 'cursor', + 'limit': 'limit', + 'filter': 'filter', + }, + 'location_map': { + 'raw': 'query', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'cursor': 'query', + 'limit': 'query', + 'filter': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.tax_rates_delete_endpoint = _Endpoint( + settings={ + 'response_type': (DeleteTaxRateResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/accounting/tax-rates/{id}', + 'operation_id': 'tax_rates_delete', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + }, + 'location_map': { + 'id': 'path', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.tax_rates_one_endpoint = _Endpoint( + settings={ + 'response_type': (GetTaxRateResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/accounting/tax-rates/{id}', + 'operation_id': 'tax_rates_one', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + }, + 'location_map': { + 'id': 'path', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.tax_rates_update_endpoint = _Endpoint( + settings={ + 'response_type': (UpdateTaxRateResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/accounting/tax-rates/{id}', + 'operation_id': 'tax_rates_update', + 'http_method': 'PATCH', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'tax_rate', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + ], + 'required': [ + 'id', + 'tax_rate', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'tax_rate': + (TaxRate,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + }, + 'location_map': { + 'id': 'path', + 'tax_rate': 'body', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + + def balance_sheet_one( + self, + **kwargs + ): + """Get BalanceSheet # noqa: E501 + + Get BalanceSheet # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.balance_sheet_one(async_req=True) + >>> result = thread.get() + + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + pass_through (Passthrough): Optional unmapped key/values that will be passed through to downstream as query parameters. [optional] + filter (BalanceSheetFilter): Apply filters. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + GetBalanceSheetResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + return self.balance_sheet_one_endpoint.call_with_http_info(**kwargs) + + def bills_add( + self, + bill, + **kwargs + ): + """Create Bill # noqa: E501 + + Create Bill # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.bills_add(bill, async_req=True) + >>> result = thread.get() + + Args: + bill (Bill): + + Keyword Args: + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + CreateBillResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['bill'] = \ + bill + return self.bills_add_endpoint.call_with_http_info(**kwargs) + + def bills_all( + self, + **kwargs + ): + """List Bills # noqa: E501 + + List Bills # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.bills_all(async_req=True) + >>> result = thread.get() + + + Keyword Args: + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + cursor (str, none_type): Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.. [optional] + limit (int): Number of records to return. [optional] if omitted the server will use the default value of 20 + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + GetBillsResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + return self.bills_all_endpoint.call_with_http_info(**kwargs) + + def bills_delete( + self, + id, + **kwargs + ): + """Delete Bill # noqa: E501 + + Delete Bill # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.bills_delete(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + DeleteBillResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + return self.bills_delete_endpoint.call_with_http_info(**kwargs) + + def bills_one( + self, + id, + **kwargs + ): + """Get Bill # noqa: E501 + + Get Bill # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.bills_one(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + GetBillResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + return self.bills_one_endpoint.call_with_http_info(**kwargs) + + def bills_update( + self, + id, + bill, + **kwargs + ): + """Update Bill # noqa: E501 + + Update Bill # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.bills_update(id, bill, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + bill (Bill): + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + UpdateBillResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + kwargs['bill'] = \ + bill + return self.bills_update_endpoint.call_with_http_info(**kwargs) + + def company_info_one( + self, + **kwargs + ): + """Get company info # noqa: E501 + + Get company info # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.company_info_one(async_req=True) + >>> result = thread.get() + + + Keyword Args: + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + GetCompanyInfoResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + return self.company_info_one_endpoint.call_with_http_info(**kwargs) + + def credit_notes_add( + self, + credit_note, + **kwargs + ): + """Create Credit Note # noqa: E501 + + Create Credit Note # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.credit_notes_add(credit_note, async_req=True) + >>> result = thread.get() + + Args: + credit_note (CreditNote): + + Keyword Args: + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + CreateCreditNoteResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['credit_note'] = \ + credit_note + return self.credit_notes_add_endpoint.call_with_http_info(**kwargs) + + def credit_notes_all( + self, + **kwargs + ): + """List Credit Notes # noqa: E501 + + List Credit Notes # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.credit_notes_all(async_req=True) + >>> result = thread.get() + + + Keyword Args: + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + cursor (str, none_type): Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.. [optional] + limit (int): Number of records to return. [optional] if omitted the server will use the default value of 20 + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + GetCreditNotesResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + return self.credit_notes_all_endpoint.call_with_http_info(**kwargs) + + def credit_notes_delete( + self, + id, + **kwargs + ): + """Delete Credit Note # noqa: E501 + + Delete Credit Note # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.credit_notes_delete(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + DeleteCreditNoteResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + return self.credit_notes_delete_endpoint.call_with_http_info(**kwargs) + + def credit_notes_one( + self, + id, + **kwargs + ): + """Get Credit Note # noqa: E501 + + Get Credit Note # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.credit_notes_one(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + GetCreditNoteResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + return self.credit_notes_one_endpoint.call_with_http_info(**kwargs) + + def credit_notes_update( + self, + id, + credit_note, + **kwargs + ): + """Update Credit Note # noqa: E501 + + Update Credit Note # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.credit_notes_update(id, credit_note, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + credit_note (CreditNote): + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + UpdateCreditNoteResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + kwargs['credit_note'] = \ + credit_note + return self.credit_notes_update_endpoint.call_with_http_info(**kwargs) + + def customers_add( + self, + accounting_customer, + **kwargs + ): + """Create Customer # noqa: E501 + + Create Customer # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.customers_add(accounting_customer, async_req=True) + >>> result = thread.get() + + Args: + accounting_customer (AccountingCustomer): + + Keyword Args: + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + CreateCustomerResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['accounting_customer'] = \ + accounting_customer + return self.customers_add_endpoint.call_with_http_info(**kwargs) + + def customers_all( + self, + **kwargs + ): + """List Customers # noqa: E501 + + List Customers # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.customers_all(async_req=True) + >>> result = thread.get() + + + Keyword Args: + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + cursor (str, none_type): Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.. [optional] + limit (int): Number of records to return. [optional] if omitted the server will use the default value of 20 + filter (CustomersFilter): Apply filters. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + GetCustomersResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + return self.customers_all_endpoint.call_with_http_info(**kwargs) + + def customers_delete( + self, + id, + **kwargs + ): + """Delete Customer # noqa: E501 + + Delete Customer # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.customers_delete(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + DeleteCustomerResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + return self.customers_delete_endpoint.call_with_http_info(**kwargs) + + def customers_one( + self, + id, + **kwargs + ): + """Get Customer # noqa: E501 + + Get Customer # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.customers_one(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + GetCustomerResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + return self.customers_one_endpoint.call_with_http_info(**kwargs) + + def customers_update( + self, + id, + accounting_customer, + **kwargs + ): + """Update Customer # noqa: E501 + + Update Customer # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.customers_update(id, accounting_customer, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + accounting_customer (AccountingCustomer): + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + UpdateCustomerResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + kwargs['accounting_customer'] = \ + accounting_customer + return self.customers_update_endpoint.call_with_http_info(**kwargs) + + def invoice_items_add( + self, + invoice_item, + **kwargs + ): + """Create Invoice Item # noqa: E501 + + Create Invoice Item # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.invoice_items_add(invoice_item, async_req=True) + >>> result = thread.get() + + Args: + invoice_item (InvoiceItem): + + Keyword Args: + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + CreateInvoiceItemResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['invoice_item'] = \ + invoice_item + return self.invoice_items_add_endpoint.call_with_http_info(**kwargs) + + def invoice_items_all( + self, + **kwargs + ): + """List Invoice Items # noqa: E501 + + List Invoice Items # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.invoice_items_all(async_req=True) + >>> result = thread.get() + + + Keyword Args: + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + cursor (str, none_type): Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.. [optional] + limit (int): Number of records to return. [optional] if omitted the server will use the default value of 20 + filter (InvoiceItemsFilter): Apply filters. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + GetInvoiceItemsResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + return self.invoice_items_all_endpoint.call_with_http_info(**kwargs) + + def invoice_items_delete( + self, + id, + **kwargs + ): + """Delete Invoice Item # noqa: E501 + + Delete Invoice Item # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.invoice_items_delete(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + DeleteTaxRateResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + return self.invoice_items_delete_endpoint.call_with_http_info(**kwargs) + + def invoice_items_one( + self, + id, + **kwargs + ): + """Get Invoice Item # noqa: E501 + + Get Invoice Item # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.invoice_items_one(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + GetInvoiceItemResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + return self.invoice_items_one_endpoint.call_with_http_info(**kwargs) + + def invoice_items_update( + self, + id, + invoice_item, + **kwargs + ): + """Update Invoice Item # noqa: E501 + + Update Invoice Item # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.invoice_items_update(id, invoice_item, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + invoice_item (InvoiceItem): + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + UpdateInvoiceItemsResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + kwargs['invoice_item'] = \ + invoice_item + return self.invoice_items_update_endpoint.call_with_http_info(**kwargs) + + def invoices_add( + self, + invoice, + **kwargs + ): + """Create Invoice # noqa: E501 + + Create Invoice # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.invoices_add(invoice, async_req=True) + >>> result = thread.get() + + Args: + invoice (Invoice): + + Keyword Args: + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + CreateInvoiceResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['invoice'] = \ + invoice + return self.invoices_add_endpoint.call_with_http_info(**kwargs) + + def invoices_all( + self, + **kwargs + ): + """List Invoices # noqa: E501 + + List Invoices # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.invoices_all(async_req=True) + >>> result = thread.get() + + + Keyword Args: + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + cursor (str, none_type): Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.. [optional] + limit (int): Number of records to return. [optional] if omitted the server will use the default value of 20 + sort (InvoicesSort): Apply sorting. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + GetInvoicesResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + return self.invoices_all_endpoint.call_with_http_info(**kwargs) + + def invoices_delete( + self, + id, + **kwargs + ): + """Delete Invoice # noqa: E501 + + Delete Invoice # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.invoices_delete(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + DeleteInvoiceResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + return self.invoices_delete_endpoint.call_with_http_info(**kwargs) + + def invoices_one( + self, + id, + **kwargs + ): + """Get Invoice # noqa: E501 + + Get Invoice # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.invoices_one(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + GetInvoiceResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + return self.invoices_one_endpoint.call_with_http_info(**kwargs) + + def invoices_update( + self, + id, + invoice, + **kwargs + ): + """Update Invoice # noqa: E501 + + Update Invoice # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.invoices_update(id, invoice, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + invoice (Invoice): + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + UpdateInvoiceResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + kwargs['invoice'] = \ + invoice + return self.invoices_update_endpoint.call_with_http_info(**kwargs) + + def ledger_accounts_add( + self, + ledger_account, + **kwargs + ): + """Create Ledger Account # noqa: E501 + + Create Ledger Account # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.ledger_accounts_add(ledger_account, async_req=True) + >>> result = thread.get() + + Args: + ledger_account (LedgerAccount): + + Keyword Args: + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + CreateLedgerAccountResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['ledger_account'] = \ + ledger_account + return self.ledger_accounts_add_endpoint.call_with_http_info(**kwargs) + + def ledger_accounts_all( + self, + **kwargs + ): + """List Ledger Accounts # noqa: E501 + + List Ledger Accounts # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.ledger_accounts_all(async_req=True) + >>> result = thread.get() + + + Keyword Args: + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + cursor (str, none_type): Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.. [optional] + limit (int): Number of records to return. [optional] if omitted the server will use the default value of 20 + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + GetLedgerAccountsResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + return self.ledger_accounts_all_endpoint.call_with_http_info(**kwargs) + + def ledger_accounts_delete( + self, + id, + **kwargs + ): + """Delete Ledger Account # noqa: E501 + + Delete Ledger Account # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.ledger_accounts_delete(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + DeleteLedgerAccountResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + return self.ledger_accounts_delete_endpoint.call_with_http_info(**kwargs) + + def ledger_accounts_one( + self, + id, + **kwargs + ): + """Get Ledger Account # noqa: E501 + + Get Ledger Account # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.ledger_accounts_one(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + GetLedgerAccountResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + return self.ledger_accounts_one_endpoint.call_with_http_info(**kwargs) + + def ledger_accounts_update( + self, + id, + ledger_account, + **kwargs + ): + """Update Ledger Account # noqa: E501 + + Update Ledger Account # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.ledger_accounts_update(id, ledger_account, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + ledger_account (LedgerAccount): + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + UpdateLedgerAccountResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + kwargs['ledger_account'] = \ + ledger_account + return self.ledger_accounts_update_endpoint.call_with_http_info(**kwargs) + + def payments_add( + self, + payment, + **kwargs + ): + """Create Payment # noqa: E501 + + Create Payment # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.payments_add(payment, async_req=True) + >>> result = thread.get() + + Args: + payment (Payment): + + Keyword Args: + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + CreatePaymentResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['payment'] = \ + payment + return self.payments_add_endpoint.call_with_http_info(**kwargs) + + def payments_all( + self, + **kwargs + ): + """List Payments # noqa: E501 + + List Payments # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.payments_all(async_req=True) + >>> result = thread.get() + + + Keyword Args: + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + cursor (str, none_type): Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.. [optional] + limit (int): Number of records to return. [optional] if omitted the server will use the default value of 20 + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + GetPaymentsResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + return self.payments_all_endpoint.call_with_http_info(**kwargs) + + def payments_delete( + self, + id, + **kwargs + ): + """Delete Payment # noqa: E501 + + Delete Payment # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.payments_delete(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + DeletePaymentResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + return self.payments_delete_endpoint.call_with_http_info(**kwargs) + + def payments_one( + self, + id, + **kwargs + ): + """Get Payment # noqa: E501 + + Get Payment # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.payments_one(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + GetPaymentResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + return self.payments_one_endpoint.call_with_http_info(**kwargs) + + def payments_update( + self, + id, + payment, + **kwargs + ): + """Update Payment # noqa: E501 + + Update Payment # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.payments_update(id, payment, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + payment (Payment): + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + UpdatePaymentResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + kwargs['payment'] = \ + payment + return self.payments_update_endpoint.call_with_http_info(**kwargs) + + def profit_and_loss_one( + self, + **kwargs + ): + """Get Profit and Loss # noqa: E501 + + Get Profit and Loss # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.profit_and_loss_one(async_req=True) + >>> result = thread.get() + + + Keyword Args: + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + filter (ProfitAndLossFilter): Apply filters. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + GetProfitAndLossResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + return self.profit_and_loss_one_endpoint.call_with_http_info(**kwargs) + + def suppliers_add( + self, + supplier, + **kwargs + ): + """Create Supplier # noqa: E501 + + Create Supplier # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.suppliers_add(supplier, async_req=True) + >>> result = thread.get() + + Args: + supplier (Supplier): + + Keyword Args: + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + CreateSupplierResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['supplier'] = \ + supplier + return self.suppliers_add_endpoint.call_with_http_info(**kwargs) + + def suppliers_all( + self, + **kwargs + ): + """List Suppliers # noqa: E501 + + List Suppliers # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.suppliers_all(async_req=True) + >>> result = thread.get() + + + Keyword Args: + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + cursor (str, none_type): Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.. [optional] + limit (int): Number of records to return. [optional] if omitted the server will use the default value of 20 + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + GetSuppliersResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + return self.suppliers_all_endpoint.call_with_http_info(**kwargs) + + def suppliers_delete( + self, + id, + **kwargs + ): + """Delete Supplier # noqa: E501 + + Delete Supplier # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.suppliers_delete(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + DeleteSupplierResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + return self.suppliers_delete_endpoint.call_with_http_info(**kwargs) + + def suppliers_one( + self, + id, + **kwargs + ): + """Get Supplier # noqa: E501 + + Get Supplier # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.suppliers_one(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + GetSupplierResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + return self.suppliers_one_endpoint.call_with_http_info(**kwargs) + + def suppliers_update( + self, + id, + supplier, + **kwargs + ): + """Update Supplier # noqa: E501 + + Update Supplier # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.suppliers_update(id, supplier, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + supplier (Supplier): + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + UpdateSupplierResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + kwargs['supplier'] = \ + supplier + return self.suppliers_update_endpoint.call_with_http_info(**kwargs) + + def tax_rates_add( + self, + tax_rate, + **kwargs + ): + """Create Tax Rate # noqa: E501 + + Create Tax Rate # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.tax_rates_add(tax_rate, async_req=True) + >>> result = thread.get() + + Args: + tax_rate (TaxRate): + + Keyword Args: + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + CreateTaxRateResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['tax_rate'] = \ + tax_rate + return self.tax_rates_add_endpoint.call_with_http_info(**kwargs) + + def tax_rates_all( + self, + **kwargs + ): + """List Tax Rates # noqa: E501 + + List Tax Rates. Note: Not all connectors return the actual rate/percentage value. In this case, only the tax code or reference is returned. Connectors Affected: Quickbooks # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.tax_rates_all(async_req=True) + >>> result = thread.get() + + + Keyword Args: + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + cursor (str, none_type): Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.. [optional] + limit (int): Number of records to return. [optional] if omitted the server will use the default value of 20 + filter (TaxRatesFilter): Apply filters. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + GetTaxRatesResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + return self.tax_rates_all_endpoint.call_with_http_info(**kwargs) + + def tax_rates_delete( + self, + id, + **kwargs + ): + """Delete Tax Rate # noqa: E501 + + Delete Tax Rate # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.tax_rates_delete(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + DeleteTaxRateResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + return self.tax_rates_delete_endpoint.call_with_http_info(**kwargs) + + def tax_rates_one( + self, + id, + **kwargs + ): + """Get Tax Rate # noqa: E501 + + Get Tax Rate. Note: Not all connectors return the actual rate/percentage value. In this case, only the tax code or reference is returned. Support will soon be added to return the actual rate/percentage by doing additional calls in the background to provide the full view of a given tax rate. Connectors Affected: Quickbooks # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.tax_rates_one(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + GetTaxRateResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + return self.tax_rates_one_endpoint.call_with_http_info(**kwargs) + + def tax_rates_update( + self, + id, + tax_rate, + **kwargs + ): + """Update Tax Rate # noqa: E501 + + Update Tax Rate # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.tax_rates_update(id, tax_rate, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + tax_rate (TaxRate): + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + UpdateTaxRateResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + kwargs['tax_rate'] = \ + tax_rate + return self.tax_rates_update_endpoint.call_with_http_info(**kwargs) + diff --git a/src/apideck/api/ats_api.py b/src/apideck/api/ats_api.py new file mode 100644 index 0000000000..e092e5dc3e --- /dev/null +++ b/src/apideck/api/ats_api.py @@ -0,0 +1,836 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.api_client import ApiClient, Endpoint as _Endpoint +from apideck.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) +from apideck.model.applicant import Applicant +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.create_applicant_response import CreateApplicantResponse +from apideck.model.get_applicant_response import GetApplicantResponse +from apideck.model.get_applicants_response import GetApplicantsResponse +from apideck.model.get_job_response import GetJobResponse +from apideck.model.get_jobs_response import GetJobsResponse +from apideck.model.jobs_filter import JobsFilter +from apideck.model.not_found_response import NotFoundResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unprocessable_response import UnprocessableResponse + + +class AtsApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.applicants_add_endpoint = _Endpoint( + settings={ + 'response_type': (CreateApplicantResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/ats/applicants', + 'operation_id': 'applicants_add', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'applicant', + 'raw', + 'consumer_id', + 'app_id', + 'service_id', + ], + 'required': [ + 'applicant', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'applicant': + (Applicant,), + 'raw': + (bool,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + }, + 'attribute_map': { + 'raw': 'raw', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + }, + 'location_map': { + 'applicant': 'body', + 'raw': 'query', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.applicants_all_endpoint = _Endpoint( + settings={ + 'response_type': (GetApplicantsResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/ats/applicants', + 'operation_id': 'applicants_all', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'raw', + 'consumer_id', + 'app_id', + 'service_id', + 'cursor', + 'limit', + 'filter', + ], + 'required': [], + 'nullable': [ + 'cursor', + ], + 'enum': [ + ], + 'validation': [ + 'limit', + ] + }, + root_map={ + 'validations': { + ('limit',): { + + 'inclusive_maximum': 200, + 'inclusive_minimum': 1, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'raw': + (bool,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'cursor': + (str, none_type,), + 'limit': + (int,), + 'filter': + (JobsFilter,), + }, + 'attribute_map': { + 'raw': 'raw', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'cursor': 'cursor', + 'limit': 'limit', + 'filter': 'filter', + }, + 'location_map': { + 'raw': 'query', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'cursor': 'query', + 'limit': 'query', + 'filter': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.applicants_one_endpoint = _Endpoint( + settings={ + 'response_type': (GetApplicantResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/ats/applicants/{id}', + 'operation_id': 'applicants_one', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + }, + 'location_map': { + 'id': 'path', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.jobs_all_endpoint = _Endpoint( + settings={ + 'response_type': (GetJobsResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/ats/jobs', + 'operation_id': 'jobs_all', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'raw', + 'consumer_id', + 'app_id', + 'service_id', + 'cursor', + 'limit', + ], + 'required': [], + 'nullable': [ + 'cursor', + ], + 'enum': [ + ], + 'validation': [ + 'limit', + ] + }, + root_map={ + 'validations': { + ('limit',): { + + 'inclusive_maximum': 200, + 'inclusive_minimum': 1, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'raw': + (bool,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'cursor': + (str, none_type,), + 'limit': + (int,), + }, + 'attribute_map': { + 'raw': 'raw', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'cursor': 'cursor', + 'limit': 'limit', + }, + 'location_map': { + 'raw': 'query', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'cursor': 'query', + 'limit': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.jobs_one_endpoint = _Endpoint( + settings={ + 'response_type': (GetJobResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/ats/jobs/{id}', + 'operation_id': 'jobs_one', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + }, + 'location_map': { + 'id': 'path', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def applicants_add( + self, + applicant, + **kwargs + ): + """Create applicant # noqa: E501 + + Create applicant # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.applicants_add(applicant, async_req=True) + >>> result = thread.get() + + Args: + applicant (Applicant): + + Keyword Args: + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + CreateApplicantResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['applicant'] = \ + applicant + return self.applicants_add_endpoint.call_with_http_info(**kwargs) + + def applicants_all( + self, + **kwargs + ): + """List applicants # noqa: E501 + + List applicants # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.applicants_all(async_req=True) + >>> result = thread.get() + + + Keyword Args: + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + cursor (str, none_type): Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.. [optional] + limit (int): Number of records to return. [optional] if omitted the server will use the default value of 20 + filter (JobsFilter): Apply filters. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + GetApplicantsResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + return self.applicants_all_endpoint.call_with_http_info(**kwargs) + + def applicants_one( + self, + id, + **kwargs + ): + """Get applicant # noqa: E501 + + Get applicant # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.applicants_one(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + GetApplicantResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + return self.applicants_one_endpoint.call_with_http_info(**kwargs) + + def jobs_all( + self, + **kwargs + ): + """List Jobs # noqa: E501 + + List Jobs # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.jobs_all(async_req=True) + >>> result = thread.get() + + + Keyword Args: + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + cursor (str, none_type): Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.. [optional] + limit (int): Number of records to return. [optional] if omitted the server will use the default value of 20 + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + GetJobsResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + return self.jobs_all_endpoint.call_with_http_info(**kwargs) + + def jobs_one( + self, + id, + **kwargs + ): + """Get Job # noqa: E501 + + Get Job # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.jobs_one(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + GetJobResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + return self.jobs_one_endpoint.call_with_http_info(**kwargs) + diff --git a/src/apideck/api/connector_api.py b/src/apideck/api/connector_api.py new file mode 100644 index 0000000000..5b06e85d9f --- /dev/null +++ b/src/apideck/api/connector_api.py @@ -0,0 +1,1205 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.api_client import ApiClient, Endpoint as _Endpoint +from apideck.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) +from apideck.model.apis_filter import ApisFilter +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.connectors_filter import ConnectorsFilter +from apideck.model.get_api_resource_coverage_response import GetApiResourceCoverageResponse +from apideck.model.get_api_resource_response import GetApiResourceResponse +from apideck.model.get_api_response import GetApiResponse +from apideck.model.get_apis_response import GetApisResponse +from apideck.model.get_connector_resource_response import GetConnectorResourceResponse +from apideck.model.get_connector_response import GetConnectorResponse +from apideck.model.get_connectors_response import GetConnectorsResponse +from apideck.model.not_found_response import NotFoundResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unified_api_id import UnifiedApiId + + +class ConnectorApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.api_resource_coverage_one_endpoint = _Endpoint( + settings={ + 'response_type': (GetApiResourceCoverageResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/connector/apis/{id}/resources/{resource_id}/coverage', + 'operation_id': 'api_resource_coverage_one', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'resource_id', + 'app_id', + ], + 'required': [ + 'id', + 'resource_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'resource_id': + (str,), + 'app_id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + 'resource_id': 'resource_id', + 'app_id': 'x-apideck-app-id', + }, + 'location_map': { + 'id': 'path', + 'resource_id': 'path', + 'app_id': 'header', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.api_resources_one_endpoint = _Endpoint( + settings={ + 'response_type': (GetApiResourceResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/connector/apis/{id}/resources/{resource_id}', + 'operation_id': 'api_resources_one', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'resource_id', + 'app_id', + ], + 'required': [ + 'id', + 'resource_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'resource_id': + (str,), + 'app_id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + 'resource_id': 'resource_id', + 'app_id': 'x-apideck-app-id', + }, + 'location_map': { + 'id': 'path', + 'resource_id': 'path', + 'app_id': 'header', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.apis_all_endpoint = _Endpoint( + settings={ + 'response_type': (GetApisResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/connector/apis', + 'operation_id': 'apis_all', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'app_id', + 'cursor', + 'limit', + 'filter', + ], + 'required': [], + 'nullable': [ + 'cursor', + ], + 'enum': [ + ], + 'validation': [ + 'limit', + ] + }, + root_map={ + 'validations': { + ('limit',): { + + 'inclusive_maximum': 200, + 'inclusive_minimum': 1, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'app_id': + (str,), + 'cursor': + (str, none_type,), + 'limit': + (int,), + 'filter': + (ApisFilter,), + }, + 'attribute_map': { + 'app_id': 'x-apideck-app-id', + 'cursor': 'cursor', + 'limit': 'limit', + 'filter': 'filter', + }, + 'location_map': { + 'app_id': 'header', + 'cursor': 'query', + 'limit': 'query', + 'filter': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.apis_one_endpoint = _Endpoint( + settings={ + 'response_type': (GetApiResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/connector/apis/{id}', + 'operation_id': 'apis_one', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'app_id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'app_id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + 'app_id': 'x-apideck-app-id', + }, + 'location_map': { + 'id': 'path', + 'app_id': 'header', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.connector_docs_one_endpoint = _Endpoint( + settings={ + 'response_type': (str,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/connector/connectors/{id}/docs/{doc_id}', + 'operation_id': 'connector_docs_one', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'doc_id', + 'app_id', + ], + 'required': [ + 'id', + 'doc_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'doc_id': + (str,), + 'app_id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + 'doc_id': 'doc_id', + 'app_id': 'x-apideck-app-id', + }, + 'location_map': { + 'id': 'path', + 'doc_id': 'path', + 'app_id': 'header', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'text/markdown', + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.connector_resources_one_endpoint = _Endpoint( + settings={ + 'response_type': (GetConnectorResourceResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/connector/connectors/{id}/resources/{resource_id}', + 'operation_id': 'connector_resources_one', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'resource_id', + 'app_id', + 'unified_api', + ], + 'required': [ + 'id', + 'resource_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'resource_id': + (str,), + 'app_id': + (str,), + 'unified_api': + (UnifiedApiId,), + }, + 'attribute_map': { + 'id': 'id', + 'resource_id': 'resource_id', + 'app_id': 'x-apideck-app-id', + 'unified_api': 'unified_api', + }, + 'location_map': { + 'id': 'path', + 'resource_id': 'path', + 'app_id': 'header', + 'unified_api': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.connectors_all_endpoint = _Endpoint( + settings={ + 'response_type': (GetConnectorsResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/connector/connectors', + 'operation_id': 'connectors_all', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'app_id', + 'cursor', + 'limit', + 'filter', + ], + 'required': [], + 'nullable': [ + 'cursor', + ], + 'enum': [ + ], + 'validation': [ + 'limit', + ] + }, + root_map={ + 'validations': { + ('limit',): { + + 'inclusive_maximum': 200, + 'inclusive_minimum': 1, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'app_id': + (str,), + 'cursor': + (str, none_type,), + 'limit': + (int,), + 'filter': + (ConnectorsFilter,), + }, + 'attribute_map': { + 'app_id': 'x-apideck-app-id', + 'cursor': 'cursor', + 'limit': 'limit', + 'filter': 'filter', + }, + 'location_map': { + 'app_id': 'header', + 'cursor': 'query', + 'limit': 'query', + 'filter': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.connectors_one_endpoint = _Endpoint( + settings={ + 'response_type': (GetConnectorResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/connector/connectors/{id}', + 'operation_id': 'connectors_one', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'app_id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'app_id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + 'app_id': 'x-apideck-app-id', + }, + 'location_map': { + 'id': 'path', + 'app_id': 'header', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def api_resource_coverage_one( + self, + id, + resource_id, + **kwargs + ): + """Get API Resource Coverage # noqa: E501 + + Get API Resource Coverage # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.api_resource_coverage_one(id, resource_id, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + resource_id (str): ID of the resource you are acting upon. + + Keyword Args: + app_id (str): The ID of your Unify application. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + GetApiResourceCoverageResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + kwargs['resource_id'] = \ + resource_id + return self.api_resource_coverage_one_endpoint.call_with_http_info(**kwargs) + + def api_resources_one( + self, + id, + resource_id, + **kwargs + ): + """Get API Resource # noqa: E501 + + Get API Resource # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.api_resources_one(id, resource_id, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + resource_id (str): ID of the resource you are acting upon. + + Keyword Args: + app_id (str): The ID of your Unify application. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + GetApiResourceResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + kwargs['resource_id'] = \ + resource_id + return self.api_resources_one_endpoint.call_with_http_info(**kwargs) + + def apis_all( + self, + **kwargs + ): + """List APIs # noqa: E501 + + List APIs # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.apis_all(async_req=True) + >>> result = thread.get() + + + Keyword Args: + app_id (str): The ID of your Unify application. [optional] + cursor (str, none_type): Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.. [optional] + limit (int): Number of records to return. [optional] if omitted the server will use the default value of 20 + filter (ApisFilter): Apply filters. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + GetApisResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + return self.apis_all_endpoint.call_with_http_info(**kwargs) + + def apis_one( + self, + id, + **kwargs + ): + """Get API # noqa: E501 + + Get API # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.apis_one(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + + Keyword Args: + app_id (str): The ID of your Unify application. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + GetApiResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + return self.apis_one_endpoint.call_with_http_info(**kwargs) + + def connector_docs_one( + self, + id, + doc_id, + **kwargs + ): + """Get Connector Doc content # noqa: E501 + + Get Connector Doc content # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.connector_docs_one(id, doc_id, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + doc_id (str): ID of the Doc + + Keyword Args: + app_id (str): The ID of your Unify application. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + str + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + kwargs['doc_id'] = \ + doc_id + return self.connector_docs_one_endpoint.call_with_http_info(**kwargs) + + def connector_resources_one( + self, + id, + resource_id, + **kwargs + ): + """Get Connector Resource # noqa: E501 + + Get Connector Resource # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.connector_resources_one(id, resource_id, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + resource_id (str): ID of the resource you are acting upon. + + Keyword Args: + app_id (str): The ID of your Unify application. [optional] + unified_api (UnifiedApiId): Specify unified API for the connector resource. This is useful when a resource appears in multiple APIs. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + GetConnectorResourceResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + kwargs['resource_id'] = \ + resource_id + return self.connector_resources_one_endpoint.call_with_http_info(**kwargs) + + def connectors_all( + self, + **kwargs + ): + """List Connectors # noqa: E501 + + List Connectors # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.connectors_all(async_req=True) + >>> result = thread.get() + + + Keyword Args: + app_id (str): The ID of your Unify application. [optional] + cursor (str, none_type): Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.. [optional] + limit (int): Number of records to return. [optional] if omitted the server will use the default value of 20 + filter (ConnectorsFilter): Apply filters. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + GetConnectorsResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + return self.connectors_all_endpoint.call_with_http_info(**kwargs) + + def connectors_one( + self, + id, + **kwargs + ): + """Get Connector # noqa: E501 + + Get Connector # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.connectors_one(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + + Keyword Args: + app_id (str): The ID of your Unify application. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + GetConnectorResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + return self.connectors_one_endpoint.call_with_http_info(**kwargs) + diff --git a/src/apideck/api/crm_api.py b/src/apideck/api/crm_api.py new file mode 100644 index 0000000000..9dc15cfcb7 --- /dev/null +++ b/src/apideck/api/crm_api.py @@ -0,0 +1,6419 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.api_client import ApiClient, Endpoint as _Endpoint +from apideck.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) +from apideck.model.activity import Activity +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.companies_filter import CompaniesFilter +from apideck.model.companies_sort import CompaniesSort +from apideck.model.company import Company +from apideck.model.contact import Contact +from apideck.model.contacts_filter import ContactsFilter +from apideck.model.contacts_sort import ContactsSort +from apideck.model.create_activity_response import CreateActivityResponse +from apideck.model.create_company_response import CreateCompanyResponse +from apideck.model.create_contact_response import CreateContactResponse +from apideck.model.create_lead_response import CreateLeadResponse +from apideck.model.create_note_response import CreateNoteResponse +from apideck.model.create_opportunity_response import CreateOpportunityResponse +from apideck.model.create_pipeline_response import CreatePipelineResponse +from apideck.model.create_user_response import CreateUserResponse +from apideck.model.delete_activity_response import DeleteActivityResponse +from apideck.model.delete_company_response import DeleteCompanyResponse +from apideck.model.delete_contact_response import DeleteContactResponse +from apideck.model.delete_lead_response import DeleteLeadResponse +from apideck.model.delete_note_response import DeleteNoteResponse +from apideck.model.delete_opportunity_response import DeleteOpportunityResponse +from apideck.model.delete_pipeline_response import DeletePipelineResponse +from apideck.model.delete_user_response import DeleteUserResponse +from apideck.model.get_activities_response import GetActivitiesResponse +from apideck.model.get_activity_response import GetActivityResponse +from apideck.model.get_companies_response import GetCompaniesResponse +from apideck.model.get_company_response import GetCompanyResponse +from apideck.model.get_contact_response import GetContactResponse +from apideck.model.get_contacts_response import GetContactsResponse +from apideck.model.get_lead_response import GetLeadResponse +from apideck.model.get_leads_response import GetLeadsResponse +from apideck.model.get_note_response import GetNoteResponse +from apideck.model.get_notes_response import GetNotesResponse +from apideck.model.get_opportunities_response import GetOpportunitiesResponse +from apideck.model.get_opportunity_response import GetOpportunityResponse +from apideck.model.get_pipeline_response import GetPipelineResponse +from apideck.model.get_pipelines_response import GetPipelinesResponse +from apideck.model.get_user_response import GetUserResponse +from apideck.model.get_users_response import GetUsersResponse +from apideck.model.lead import Lead +from apideck.model.leads_filter import LeadsFilter +from apideck.model.leads_sort import LeadsSort +from apideck.model.not_found_response import NotFoundResponse +from apideck.model.note import Note +from apideck.model.opportunities_filter import OpportunitiesFilter +from apideck.model.opportunities_sort import OpportunitiesSort +from apideck.model.opportunity import Opportunity +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.pipeline import Pipeline +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.update_activity_response import UpdateActivityResponse +from apideck.model.update_company_response import UpdateCompanyResponse +from apideck.model.update_contact_response import UpdateContactResponse +from apideck.model.update_lead_response import UpdateLeadResponse +from apideck.model.update_note_response import UpdateNoteResponse +from apideck.model.update_opportunity_response import UpdateOpportunityResponse +from apideck.model.update_pipeline_response import UpdatePipelineResponse +from apideck.model.update_user_response import UpdateUserResponse +from apideck.model.user import User + + +class CrmApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.activities_add_endpoint = _Endpoint( + settings={ + 'response_type': (CreateActivityResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/crm/activities', + 'operation_id': 'activities_add', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'activity', + 'raw', + 'consumer_id', + 'app_id', + 'service_id', + ], + 'required': [ + 'activity', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'activity': + (Activity,), + 'raw': + (bool,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + }, + 'attribute_map': { + 'raw': 'raw', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + }, + 'location_map': { + 'activity': 'body', + 'raw': 'query', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.activities_all_endpoint = _Endpoint( + settings={ + 'response_type': (GetActivitiesResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/crm/activities', + 'operation_id': 'activities_all', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'raw', + 'consumer_id', + 'app_id', + 'service_id', + 'cursor', + 'limit', + ], + 'required': [], + 'nullable': [ + 'cursor', + ], + 'enum': [ + ], + 'validation': [ + 'limit', + ] + }, + root_map={ + 'validations': { + ('limit',): { + + 'inclusive_maximum': 200, + 'inclusive_minimum': 1, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'raw': + (bool,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'cursor': + (str, none_type,), + 'limit': + (int,), + }, + 'attribute_map': { + 'raw': 'raw', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'cursor': 'cursor', + 'limit': 'limit', + }, + 'location_map': { + 'raw': 'query', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'cursor': 'query', + 'limit': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.activities_delete_endpoint = _Endpoint( + settings={ + 'response_type': (DeleteActivityResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/crm/activities/{id}', + 'operation_id': 'activities_delete', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + }, + 'location_map': { + 'id': 'path', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.activities_one_endpoint = _Endpoint( + settings={ + 'response_type': (GetActivityResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/crm/activities/{id}', + 'operation_id': 'activities_one', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + }, + 'location_map': { + 'id': 'path', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.activities_update_endpoint = _Endpoint( + settings={ + 'response_type': (UpdateActivityResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/crm/activities/{id}', + 'operation_id': 'activities_update', + 'http_method': 'PATCH', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'activity', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + ], + 'required': [ + 'id', + 'activity', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'activity': + (Activity,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + }, + 'location_map': { + 'id': 'path', + 'activity': 'body', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.companies_add_endpoint = _Endpoint( + settings={ + 'response_type': (CreateCompanyResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/crm/companies', + 'operation_id': 'companies_add', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'company', + 'raw', + 'consumer_id', + 'app_id', + 'service_id', + ], + 'required': [ + 'company', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'company': + (Company,), + 'raw': + (bool,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + }, + 'attribute_map': { + 'raw': 'raw', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + }, + 'location_map': { + 'company': 'body', + 'raw': 'query', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.companies_all_endpoint = _Endpoint( + settings={ + 'response_type': (GetCompaniesResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/crm/companies', + 'operation_id': 'companies_all', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'raw', + 'consumer_id', + 'app_id', + 'service_id', + 'cursor', + 'limit', + 'filter', + 'sort', + ], + 'required': [], + 'nullable': [ + 'cursor', + ], + 'enum': [ + ], + 'validation': [ + 'limit', + ] + }, + root_map={ + 'validations': { + ('limit',): { + + 'inclusive_maximum': 200, + 'inclusive_minimum': 1, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'raw': + (bool,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'cursor': + (str, none_type,), + 'limit': + (int,), + 'filter': + (CompaniesFilter,), + 'sort': + (CompaniesSort,), + }, + 'attribute_map': { + 'raw': 'raw', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'cursor': 'cursor', + 'limit': 'limit', + 'filter': 'filter', + 'sort': 'sort', + }, + 'location_map': { + 'raw': 'query', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'cursor': 'query', + 'limit': 'query', + 'filter': 'query', + 'sort': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.companies_delete_endpoint = _Endpoint( + settings={ + 'response_type': (DeleteCompanyResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/crm/companies/{id}', + 'operation_id': 'companies_delete', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'raw', + 'consumer_id', + 'app_id', + 'service_id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'raw': + (bool,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + 'raw': 'raw', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + }, + 'location_map': { + 'id': 'path', + 'raw': 'query', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.companies_one_endpoint = _Endpoint( + settings={ + 'response_type': (GetCompanyResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/crm/companies/{id}', + 'operation_id': 'companies_one', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'raw', + 'consumer_id', + 'app_id', + 'service_id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'raw': + (bool,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + 'raw': 'raw', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + }, + 'location_map': { + 'id': 'path', + 'raw': 'query', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.companies_update_endpoint = _Endpoint( + settings={ + 'response_type': (UpdateCompanyResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/crm/companies/{id}', + 'operation_id': 'companies_update', + 'http_method': 'PATCH', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'company', + 'raw', + 'consumer_id', + 'app_id', + 'service_id', + ], + 'required': [ + 'id', + 'company', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'company': + (Company,), + 'raw': + (bool,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + 'raw': 'raw', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + }, + 'location_map': { + 'id': 'path', + 'company': 'body', + 'raw': 'query', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.contacts_add_endpoint = _Endpoint( + settings={ + 'response_type': (CreateContactResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/crm/contacts', + 'operation_id': 'contacts_add', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'contact', + 'raw', + 'consumer_id', + 'app_id', + 'service_id', + ], + 'required': [ + 'contact', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'contact': + (Contact,), + 'raw': + (bool,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + }, + 'attribute_map': { + 'raw': 'raw', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + }, + 'location_map': { + 'contact': 'body', + 'raw': 'query', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.contacts_all_endpoint = _Endpoint( + settings={ + 'response_type': (GetContactsResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/crm/contacts', + 'operation_id': 'contacts_all', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'raw', + 'consumer_id', + 'app_id', + 'service_id', + 'cursor', + 'limit', + 'filter', + 'sort', + ], + 'required': [], + 'nullable': [ + 'cursor', + ], + 'enum': [ + ], + 'validation': [ + 'limit', + ] + }, + root_map={ + 'validations': { + ('limit',): { + + 'inclusive_maximum': 200, + 'inclusive_minimum': 1, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'raw': + (bool,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'cursor': + (str, none_type,), + 'limit': + (int,), + 'filter': + (ContactsFilter,), + 'sort': + (ContactsSort,), + }, + 'attribute_map': { + 'raw': 'raw', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'cursor': 'cursor', + 'limit': 'limit', + 'filter': 'filter', + 'sort': 'sort', + }, + 'location_map': { + 'raw': 'query', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'cursor': 'query', + 'limit': 'query', + 'filter': 'query', + 'sort': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.contacts_delete_endpoint = _Endpoint( + settings={ + 'response_type': (DeleteContactResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/crm/contacts/{id}', + 'operation_id': 'contacts_delete', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + }, + 'location_map': { + 'id': 'path', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.contacts_one_endpoint = _Endpoint( + settings={ + 'response_type': (GetContactResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/crm/contacts/{id}', + 'operation_id': 'contacts_one', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + }, + 'location_map': { + 'id': 'path', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.contacts_update_endpoint = _Endpoint( + settings={ + 'response_type': (UpdateContactResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/crm/contacts/{id}', + 'operation_id': 'contacts_update', + 'http_method': 'PATCH', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'contact', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + ], + 'required': [ + 'id', + 'contact', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'contact': + (Contact,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + }, + 'location_map': { + 'id': 'path', + 'contact': 'body', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.leads_add_endpoint = _Endpoint( + settings={ + 'response_type': (CreateLeadResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/crm/leads', + 'operation_id': 'leads_add', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'lead', + 'raw', + 'consumer_id', + 'app_id', + 'service_id', + ], + 'required': [ + 'lead', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'lead': + (Lead,), + 'raw': + (bool,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + }, + 'attribute_map': { + 'raw': 'raw', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + }, + 'location_map': { + 'lead': 'body', + 'raw': 'query', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.leads_all_endpoint = _Endpoint( + settings={ + 'response_type': (GetLeadsResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/crm/leads', + 'operation_id': 'leads_all', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'raw', + 'consumer_id', + 'app_id', + 'service_id', + 'cursor', + 'limit', + 'filter', + 'sort', + ], + 'required': [], + 'nullable': [ + 'cursor', + ], + 'enum': [ + ], + 'validation': [ + 'limit', + ] + }, + root_map={ + 'validations': { + ('limit',): { + + 'inclusive_maximum': 200, + 'inclusive_minimum': 1, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'raw': + (bool,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'cursor': + (str, none_type,), + 'limit': + (int,), + 'filter': + (LeadsFilter,), + 'sort': + (LeadsSort,), + }, + 'attribute_map': { + 'raw': 'raw', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'cursor': 'cursor', + 'limit': 'limit', + 'filter': 'filter', + 'sort': 'sort', + }, + 'location_map': { + 'raw': 'query', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'cursor': 'query', + 'limit': 'query', + 'filter': 'query', + 'sort': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.leads_delete_endpoint = _Endpoint( + settings={ + 'response_type': (DeleteLeadResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/crm/leads/{id}', + 'operation_id': 'leads_delete', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + }, + 'location_map': { + 'id': 'path', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.leads_one_endpoint = _Endpoint( + settings={ + 'response_type': (GetLeadResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/crm/leads/{id}', + 'operation_id': 'leads_one', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + }, + 'location_map': { + 'id': 'path', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.leads_update_endpoint = _Endpoint( + settings={ + 'response_type': (UpdateLeadResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/crm/leads/{id}', + 'operation_id': 'leads_update', + 'http_method': 'PATCH', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'lead', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + ], + 'required': [ + 'id', + 'lead', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'lead': + (Lead,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + }, + 'location_map': { + 'id': 'path', + 'lead': 'body', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.notes_add_endpoint = _Endpoint( + settings={ + 'response_type': (CreateNoteResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/crm/notes', + 'operation_id': 'notes_add', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'note', + 'raw', + 'consumer_id', + 'app_id', + 'service_id', + ], + 'required': [ + 'note', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'note': + (Note,), + 'raw': + (bool,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + }, + 'attribute_map': { + 'raw': 'raw', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + }, + 'location_map': { + 'note': 'body', + 'raw': 'query', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.notes_all_endpoint = _Endpoint( + settings={ + 'response_type': (GetNotesResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/crm/notes', + 'operation_id': 'notes_all', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'raw', + 'consumer_id', + 'app_id', + 'service_id', + 'cursor', + 'limit', + ], + 'required': [], + 'nullable': [ + 'cursor', + ], + 'enum': [ + ], + 'validation': [ + 'limit', + ] + }, + root_map={ + 'validations': { + ('limit',): { + + 'inclusive_maximum': 200, + 'inclusive_minimum': 1, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'raw': + (bool,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'cursor': + (str, none_type,), + 'limit': + (int,), + }, + 'attribute_map': { + 'raw': 'raw', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'cursor': 'cursor', + 'limit': 'limit', + }, + 'location_map': { + 'raw': 'query', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'cursor': 'query', + 'limit': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.notes_delete_endpoint = _Endpoint( + settings={ + 'response_type': (DeleteNoteResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/crm/notes/{id}', + 'operation_id': 'notes_delete', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + }, + 'location_map': { + 'id': 'path', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.notes_one_endpoint = _Endpoint( + settings={ + 'response_type': (GetNoteResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/crm/notes/{id}', + 'operation_id': 'notes_one', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + }, + 'location_map': { + 'id': 'path', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.notes_update_endpoint = _Endpoint( + settings={ + 'response_type': (UpdateNoteResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/crm/notes/{id}', + 'operation_id': 'notes_update', + 'http_method': 'PATCH', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'note', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + ], + 'required': [ + 'id', + 'note', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'note': + (Note,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + }, + 'location_map': { + 'id': 'path', + 'note': 'body', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.opportunities_add_endpoint = _Endpoint( + settings={ + 'response_type': (CreateOpportunityResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/crm/opportunities', + 'operation_id': 'opportunities_add', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'opportunity', + 'raw', + 'consumer_id', + 'app_id', + 'service_id', + ], + 'required': [ + 'opportunity', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'opportunity': + (Opportunity,), + 'raw': + (bool,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + }, + 'attribute_map': { + 'raw': 'raw', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + }, + 'location_map': { + 'opportunity': 'body', + 'raw': 'query', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.opportunities_all_endpoint = _Endpoint( + settings={ + 'response_type': (GetOpportunitiesResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/crm/opportunities', + 'operation_id': 'opportunities_all', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'raw', + 'consumer_id', + 'app_id', + 'service_id', + 'cursor', + 'limit', + 'filter', + 'sort', + ], + 'required': [], + 'nullable': [ + 'cursor', + ], + 'enum': [ + ], + 'validation': [ + 'limit', + ] + }, + root_map={ + 'validations': { + ('limit',): { + + 'inclusive_maximum': 200, + 'inclusive_minimum': 1, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'raw': + (bool,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'cursor': + (str, none_type,), + 'limit': + (int,), + 'filter': + (OpportunitiesFilter,), + 'sort': + (OpportunitiesSort,), + }, + 'attribute_map': { + 'raw': 'raw', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'cursor': 'cursor', + 'limit': 'limit', + 'filter': 'filter', + 'sort': 'sort', + }, + 'location_map': { + 'raw': 'query', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'cursor': 'query', + 'limit': 'query', + 'filter': 'query', + 'sort': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.opportunities_delete_endpoint = _Endpoint( + settings={ + 'response_type': (DeleteOpportunityResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/crm/opportunities/{id}', + 'operation_id': 'opportunities_delete', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + }, + 'location_map': { + 'id': 'path', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.opportunities_one_endpoint = _Endpoint( + settings={ + 'response_type': (GetOpportunityResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/crm/opportunities/{id}', + 'operation_id': 'opportunities_one', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + }, + 'location_map': { + 'id': 'path', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.opportunities_update_endpoint = _Endpoint( + settings={ + 'response_type': (UpdateOpportunityResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/crm/opportunities/{id}', + 'operation_id': 'opportunities_update', + 'http_method': 'PATCH', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'opportunity', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + ], + 'required': [ + 'id', + 'opportunity', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'opportunity': + (Opportunity,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + }, + 'location_map': { + 'id': 'path', + 'opportunity': 'body', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.pipelines_add_endpoint = _Endpoint( + settings={ + 'response_type': (CreatePipelineResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/crm/pipelines', + 'operation_id': 'pipelines_add', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'pipeline', + 'raw', + 'consumer_id', + 'app_id', + 'service_id', + ], + 'required': [ + 'pipeline', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'pipeline': + (Pipeline,), + 'raw': + (bool,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + }, + 'attribute_map': { + 'raw': 'raw', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + }, + 'location_map': { + 'pipeline': 'body', + 'raw': 'query', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.pipelines_all_endpoint = _Endpoint( + settings={ + 'response_type': (GetPipelinesResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/crm/pipelines', + 'operation_id': 'pipelines_all', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'raw', + 'consumer_id', + 'app_id', + 'service_id', + 'cursor', + 'limit', + ], + 'required': [], + 'nullable': [ + 'cursor', + ], + 'enum': [ + ], + 'validation': [ + 'limit', + ] + }, + root_map={ + 'validations': { + ('limit',): { + + 'inclusive_maximum': 200, + 'inclusive_minimum': 1, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'raw': + (bool,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'cursor': + (str, none_type,), + 'limit': + (int,), + }, + 'attribute_map': { + 'raw': 'raw', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'cursor': 'cursor', + 'limit': 'limit', + }, + 'location_map': { + 'raw': 'query', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'cursor': 'query', + 'limit': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.pipelines_delete_endpoint = _Endpoint( + settings={ + 'response_type': (DeletePipelineResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/crm/pipelines/{id}', + 'operation_id': 'pipelines_delete', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + }, + 'location_map': { + 'id': 'path', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.pipelines_one_endpoint = _Endpoint( + settings={ + 'response_type': (GetPipelineResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/crm/pipelines/{id}', + 'operation_id': 'pipelines_one', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + }, + 'location_map': { + 'id': 'path', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.pipelines_update_endpoint = _Endpoint( + settings={ + 'response_type': (UpdatePipelineResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/crm/pipelines/{id}', + 'operation_id': 'pipelines_update', + 'http_method': 'PATCH', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'pipeline', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + ], + 'required': [ + 'id', + 'pipeline', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'pipeline': + (Pipeline,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + }, + 'location_map': { + 'id': 'path', + 'pipeline': 'body', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.users_add_endpoint = _Endpoint( + settings={ + 'response_type': (CreateUserResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/crm/users', + 'operation_id': 'users_add', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'user', + 'raw', + 'consumer_id', + 'app_id', + 'service_id', + ], + 'required': [ + 'user', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'user': + (User,), + 'raw': + (bool,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + }, + 'attribute_map': { + 'raw': 'raw', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + }, + 'location_map': { + 'user': 'body', + 'raw': 'query', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.users_all_endpoint = _Endpoint( + settings={ + 'response_type': (GetUsersResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/crm/users', + 'operation_id': 'users_all', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'raw', + 'consumer_id', + 'app_id', + 'service_id', + 'cursor', + 'limit', + ], + 'required': [], + 'nullable': [ + 'cursor', + ], + 'enum': [ + ], + 'validation': [ + 'limit', + ] + }, + root_map={ + 'validations': { + ('limit',): { + + 'inclusive_maximum': 200, + 'inclusive_minimum': 1, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'raw': + (bool,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'cursor': + (str, none_type,), + 'limit': + (int,), + }, + 'attribute_map': { + 'raw': 'raw', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'cursor': 'cursor', + 'limit': 'limit', + }, + 'location_map': { + 'raw': 'query', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'cursor': 'query', + 'limit': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.users_delete_endpoint = _Endpoint( + settings={ + 'response_type': (DeleteUserResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/crm/users/{id}', + 'operation_id': 'users_delete', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + }, + 'location_map': { + 'id': 'path', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.users_one_endpoint = _Endpoint( + settings={ + 'response_type': (GetUserResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/crm/users/{id}', + 'operation_id': 'users_one', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + }, + 'location_map': { + 'id': 'path', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.users_update_endpoint = _Endpoint( + settings={ + 'response_type': (UpdateUserResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/crm/users/{id}', + 'operation_id': 'users_update', + 'http_method': 'PATCH', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'user', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + ], + 'required': [ + 'id', + 'user', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'user': + (User,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + }, + 'location_map': { + 'id': 'path', + 'user': 'body', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + + def activities_add( + self, + activity, + **kwargs + ): + """Create activity # noqa: E501 + + Create activity # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.activities_add(activity, async_req=True) + >>> result = thread.get() + + Args: + activity (Activity): + + Keyword Args: + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + CreateActivityResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['activity'] = \ + activity + return self.activities_add_endpoint.call_with_http_info(**kwargs) + + def activities_all( + self, + **kwargs + ): + """List activities # noqa: E501 + + List activities # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.activities_all(async_req=True) + >>> result = thread.get() + + + Keyword Args: + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + cursor (str, none_type): Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.. [optional] + limit (int): Number of records to return. [optional] if omitted the server will use the default value of 20 + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + GetActivitiesResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + return self.activities_all_endpoint.call_with_http_info(**kwargs) + + def activities_delete( + self, + id, + **kwargs + ): + """Delete activity # noqa: E501 + + Delete activity # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.activities_delete(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + DeleteActivityResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + return self.activities_delete_endpoint.call_with_http_info(**kwargs) + + def activities_one( + self, + id, + **kwargs + ): + """Get activity # noqa: E501 + + Get activity # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.activities_one(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + GetActivityResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + return self.activities_one_endpoint.call_with_http_info(**kwargs) + + def activities_update( + self, + id, + activity, + **kwargs + ): + """Update activity # noqa: E501 + + Update activity # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.activities_update(id, activity, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + activity (Activity): + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + UpdateActivityResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + kwargs['activity'] = \ + activity + return self.activities_update_endpoint.call_with_http_info(**kwargs) + + def companies_add( + self, + company, + **kwargs + ): + """Create company # noqa: E501 + + Create company # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.companies_add(company, async_req=True) + >>> result = thread.get() + + Args: + company (Company): + + Keyword Args: + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + CreateCompanyResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['company'] = \ + company + return self.companies_add_endpoint.call_with_http_info(**kwargs) + + def companies_all( + self, + **kwargs + ): + """List companies # noqa: E501 + + List companies # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.companies_all(async_req=True) + >>> result = thread.get() + + + Keyword Args: + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + cursor (str, none_type): Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.. [optional] + limit (int): Number of records to return. [optional] if omitted the server will use the default value of 20 + filter (CompaniesFilter): Apply filters. [optional] + sort (CompaniesSort): Apply sorting. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + GetCompaniesResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + return self.companies_all_endpoint.call_with_http_info(**kwargs) + + def companies_delete( + self, + id, + **kwargs + ): + """Delete company # noqa: E501 + + Delete company # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.companies_delete(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + + Keyword Args: + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + DeleteCompanyResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + return self.companies_delete_endpoint.call_with_http_info(**kwargs) + + def companies_one( + self, + id, + **kwargs + ): + """Get company # noqa: E501 + + Get company # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.companies_one(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + + Keyword Args: + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + GetCompanyResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + return self.companies_one_endpoint.call_with_http_info(**kwargs) + + def companies_update( + self, + id, + company, + **kwargs + ): + """Update company # noqa: E501 + + Update company # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.companies_update(id, company, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + company (Company): + + Keyword Args: + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + UpdateCompanyResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + kwargs['company'] = \ + company + return self.companies_update_endpoint.call_with_http_info(**kwargs) + + def contacts_add( + self, + contact, + **kwargs + ): + """Create contact # noqa: E501 + + Create contact # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.contacts_add(contact, async_req=True) + >>> result = thread.get() + + Args: + contact (Contact): + + Keyword Args: + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + CreateContactResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['contact'] = \ + contact + return self.contacts_add_endpoint.call_with_http_info(**kwargs) + + def contacts_all( + self, + **kwargs + ): + """List contacts # noqa: E501 + + List contacts # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.contacts_all(async_req=True) + >>> result = thread.get() + + + Keyword Args: + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + cursor (str, none_type): Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.. [optional] + limit (int): Number of records to return. [optional] if omitted the server will use the default value of 20 + filter (ContactsFilter): Apply filters. [optional] + sort (ContactsSort): Apply sorting. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + GetContactsResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + return self.contacts_all_endpoint.call_with_http_info(**kwargs) + + def contacts_delete( + self, + id, + **kwargs + ): + """Delete contact # noqa: E501 + + Delete contact # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.contacts_delete(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + DeleteContactResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + return self.contacts_delete_endpoint.call_with_http_info(**kwargs) + + def contacts_one( + self, + id, + **kwargs + ): + """Get contact # noqa: E501 + + Get contact # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.contacts_one(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + GetContactResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + return self.contacts_one_endpoint.call_with_http_info(**kwargs) + + def contacts_update( + self, + id, + contact, + **kwargs + ): + """Update contact # noqa: E501 + + Update contact # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.contacts_update(id, contact, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + contact (Contact): + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + UpdateContactResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + kwargs['contact'] = \ + contact + return self.contacts_update_endpoint.call_with_http_info(**kwargs) + + def leads_add( + self, + lead, + **kwargs + ): + """Create lead # noqa: E501 + + Create lead # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.leads_add(lead, async_req=True) + >>> result = thread.get() + + Args: + lead (Lead): + + Keyword Args: + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + CreateLeadResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['lead'] = \ + lead + return self.leads_add_endpoint.call_with_http_info(**kwargs) + + def leads_all( + self, + **kwargs + ): + """List leads # noqa: E501 + + List leads # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.leads_all(async_req=True) + >>> result = thread.get() + + + Keyword Args: + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + cursor (str, none_type): Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.. [optional] + limit (int): Number of records to return. [optional] if omitted the server will use the default value of 20 + filter (LeadsFilter): Apply filters. [optional] + sort (LeadsSort): Apply sorting. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + GetLeadsResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + return self.leads_all_endpoint.call_with_http_info(**kwargs) + + def leads_delete( + self, + id, + **kwargs + ): + """Delete lead # noqa: E501 + + Delete lead # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.leads_delete(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + DeleteLeadResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + return self.leads_delete_endpoint.call_with_http_info(**kwargs) + + def leads_one( + self, + id, + **kwargs + ): + """Get lead # noqa: E501 + + Get lead # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.leads_one(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + GetLeadResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + return self.leads_one_endpoint.call_with_http_info(**kwargs) + + def leads_update( + self, + id, + lead, + **kwargs + ): + """Update lead # noqa: E501 + + Update lead # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.leads_update(id, lead, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + lead (Lead): + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + UpdateLeadResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + kwargs['lead'] = \ + lead + return self.leads_update_endpoint.call_with_http_info(**kwargs) + + def notes_add( + self, + note, + **kwargs + ): + """Create note # noqa: E501 + + Create note # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.notes_add(note, async_req=True) + >>> result = thread.get() + + Args: + note (Note): + + Keyword Args: + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + CreateNoteResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['note'] = \ + note + return self.notes_add_endpoint.call_with_http_info(**kwargs) + + def notes_all( + self, + **kwargs + ): + """List notes # noqa: E501 + + List notes # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.notes_all(async_req=True) + >>> result = thread.get() + + + Keyword Args: + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + cursor (str, none_type): Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.. [optional] + limit (int): Number of records to return. [optional] if omitted the server will use the default value of 20 + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + GetNotesResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + return self.notes_all_endpoint.call_with_http_info(**kwargs) + + def notes_delete( + self, + id, + **kwargs + ): + """Delete note # noqa: E501 + + Delete note # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.notes_delete(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + DeleteNoteResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + return self.notes_delete_endpoint.call_with_http_info(**kwargs) + + def notes_one( + self, + id, + **kwargs + ): + """Get note # noqa: E501 + + Get note # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.notes_one(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + GetNoteResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + return self.notes_one_endpoint.call_with_http_info(**kwargs) + + def notes_update( + self, + id, + note, + **kwargs + ): + """Update note # noqa: E501 + + Update note # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.notes_update(id, note, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + note (Note): + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + UpdateNoteResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + kwargs['note'] = \ + note + return self.notes_update_endpoint.call_with_http_info(**kwargs) + + def opportunities_add( + self, + opportunity, + **kwargs + ): + """Create opportunity # noqa: E501 + + Create opportunity # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.opportunities_add(opportunity, async_req=True) + >>> result = thread.get() + + Args: + opportunity (Opportunity): + + Keyword Args: + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + CreateOpportunityResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['opportunity'] = \ + opportunity + return self.opportunities_add_endpoint.call_with_http_info(**kwargs) + + def opportunities_all( + self, + **kwargs + ): + """List opportunities # noqa: E501 + + List opportunities # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.opportunities_all(async_req=True) + >>> result = thread.get() + + + Keyword Args: + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + cursor (str, none_type): Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.. [optional] + limit (int): Number of records to return. [optional] if omitted the server will use the default value of 20 + filter (OpportunitiesFilter): Apply filters. [optional] + sort (OpportunitiesSort): Apply sorting. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + GetOpportunitiesResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + return self.opportunities_all_endpoint.call_with_http_info(**kwargs) + + def opportunities_delete( + self, + id, + **kwargs + ): + """Delete opportunity # noqa: E501 + + Delete opportunity # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.opportunities_delete(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + DeleteOpportunityResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + return self.opportunities_delete_endpoint.call_with_http_info(**kwargs) + + def opportunities_one( + self, + id, + **kwargs + ): + """Get opportunity # noqa: E501 + + Get opportunity # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.opportunities_one(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + GetOpportunityResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + return self.opportunities_one_endpoint.call_with_http_info(**kwargs) + + def opportunities_update( + self, + id, + opportunity, + **kwargs + ): + """Update opportunity # noqa: E501 + + Update opportunity # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.opportunities_update(id, opportunity, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + opportunity (Opportunity): + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + UpdateOpportunityResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + kwargs['opportunity'] = \ + opportunity + return self.opportunities_update_endpoint.call_with_http_info(**kwargs) + + def pipelines_add( + self, + pipeline, + **kwargs + ): + """Create pipeline # noqa: E501 + + Create pipeline # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.pipelines_add(pipeline, async_req=True) + >>> result = thread.get() + + Args: + pipeline (Pipeline): + + Keyword Args: + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + CreatePipelineResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['pipeline'] = \ + pipeline + return self.pipelines_add_endpoint.call_with_http_info(**kwargs) + + def pipelines_all( + self, + **kwargs + ): + """List pipelines # noqa: E501 + + List pipelines # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.pipelines_all(async_req=True) + >>> result = thread.get() + + + Keyword Args: + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + cursor (str, none_type): Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.. [optional] + limit (int): Number of records to return. [optional] if omitted the server will use the default value of 20 + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + GetPipelinesResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + return self.pipelines_all_endpoint.call_with_http_info(**kwargs) + + def pipelines_delete( + self, + id, + **kwargs + ): + """Delete pipeline # noqa: E501 + + Delete pipeline # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.pipelines_delete(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + DeletePipelineResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + return self.pipelines_delete_endpoint.call_with_http_info(**kwargs) + + def pipelines_one( + self, + id, + **kwargs + ): + """Get pipeline # noqa: E501 + + Get pipeline # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.pipelines_one(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + GetPipelineResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + return self.pipelines_one_endpoint.call_with_http_info(**kwargs) + + def pipelines_update( + self, + id, + pipeline, + **kwargs + ): + """Update pipeline # noqa: E501 + + Update pipeline # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.pipelines_update(id, pipeline, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + pipeline (Pipeline): + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + UpdatePipelineResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + kwargs['pipeline'] = \ + pipeline + return self.pipelines_update_endpoint.call_with_http_info(**kwargs) + + def users_add( + self, + user, + **kwargs + ): + """Create user # noqa: E501 + + Create user # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.users_add(user, async_req=True) + >>> result = thread.get() + + Args: + user (User): + + Keyword Args: + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + CreateUserResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['user'] = \ + user + return self.users_add_endpoint.call_with_http_info(**kwargs) + + def users_all( + self, + **kwargs + ): + """List users # noqa: E501 + + List users # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.users_all(async_req=True) + >>> result = thread.get() + + + Keyword Args: + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + cursor (str, none_type): Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.. [optional] + limit (int): Number of records to return. [optional] if omitted the server will use the default value of 20 + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + GetUsersResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + return self.users_all_endpoint.call_with_http_info(**kwargs) + + def users_delete( + self, + id, + **kwargs + ): + """Delete user # noqa: E501 + + Delete user # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.users_delete(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + DeleteUserResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + return self.users_delete_endpoint.call_with_http_info(**kwargs) + + def users_one( + self, + id, + **kwargs + ): + """Get user # noqa: E501 + + Get user # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.users_one(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + GetUserResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + return self.users_one_endpoint.call_with_http_info(**kwargs) + + def users_update( + self, + id, + user, + **kwargs + ): + """Update user # noqa: E501 + + Update user # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.users_update(id, user, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + user (User): + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + UpdateUserResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + kwargs['user'] = \ + user + return self.users_update_endpoint.call_with_http_info(**kwargs) + diff --git a/src/apideck/api/customer_support_api.py b/src/apideck/api/customer_support_api.py new file mode 100644 index 0000000000..88d4907be6 --- /dev/null +++ b/src/apideck/api/customer_support_api.py @@ -0,0 +1,833 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.api_client import ApiClient, Endpoint as _Endpoint +from apideck.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.create_customer_support_customer_response import CreateCustomerSupportCustomerResponse +from apideck.model.customer_support_customer import CustomerSupportCustomer +from apideck.model.delete_customer_support_customer_response import DeleteCustomerSupportCustomerResponse +from apideck.model.get_customer_support_customer_response import GetCustomerSupportCustomerResponse +from apideck.model.get_customer_support_customers_response import GetCustomerSupportCustomersResponse +from apideck.model.not_found_response import NotFoundResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.update_customer_support_customer_response import UpdateCustomerSupportCustomerResponse + + +class CustomerSupportApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.customers_add_endpoint = _Endpoint( + settings={ + 'response_type': (CreateCustomerSupportCustomerResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/customer-support/customers', + 'operation_id': 'customers_add', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'customer_support_customer', + 'raw', + 'consumer_id', + 'app_id', + 'service_id', + ], + 'required': [ + 'customer_support_customer', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'customer_support_customer': + (CustomerSupportCustomer,), + 'raw': + (bool,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + }, + 'attribute_map': { + 'raw': 'raw', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + }, + 'location_map': { + 'customer_support_customer': 'body', + 'raw': 'query', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.customers_all_endpoint = _Endpoint( + settings={ + 'response_type': (GetCustomerSupportCustomersResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/customer-support/customers', + 'operation_id': 'customers_all', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'raw', + 'consumer_id', + 'app_id', + 'service_id', + 'cursor', + 'limit', + ], + 'required': [], + 'nullable': [ + 'cursor', + ], + 'enum': [ + ], + 'validation': [ + 'limit', + ] + }, + root_map={ + 'validations': { + ('limit',): { + + 'inclusive_maximum': 200, + 'inclusive_minimum': 1, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'raw': + (bool,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'cursor': + (str, none_type,), + 'limit': + (int,), + }, + 'attribute_map': { + 'raw': 'raw', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'cursor': 'cursor', + 'limit': 'limit', + }, + 'location_map': { + 'raw': 'query', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'cursor': 'query', + 'limit': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.customers_delete_endpoint = _Endpoint( + settings={ + 'response_type': (DeleteCustomerSupportCustomerResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/customer-support/customers/{id}', + 'operation_id': 'customers_delete', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + }, + 'location_map': { + 'id': 'path', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.customers_one_endpoint = _Endpoint( + settings={ + 'response_type': (GetCustomerSupportCustomerResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/customer-support/customers/{id}', + 'operation_id': 'customers_one', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + }, + 'location_map': { + 'id': 'path', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.customers_update_endpoint = _Endpoint( + settings={ + 'response_type': (UpdateCustomerSupportCustomerResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/customer-support/customers/{id}', + 'operation_id': 'customers_update', + 'http_method': 'PATCH', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'customer_support_customer', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + ], + 'required': [ + 'id', + 'customer_support_customer', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'customer_support_customer': + (CustomerSupportCustomer,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + }, + 'location_map': { + 'id': 'path', + 'customer_support_customer': 'body', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + + def customers_add( + self, + customer_support_customer, + **kwargs + ): + """Create Customer Support Customer # noqa: E501 + + Create Customer Support Customer # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.customers_add(customer_support_customer, async_req=True) + >>> result = thread.get() + + Args: + customer_support_customer (CustomerSupportCustomer): + + Keyword Args: + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + CreateCustomerSupportCustomerResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['customer_support_customer'] = \ + customer_support_customer + return self.customers_add_endpoint.call_with_http_info(**kwargs) + + def customers_all( + self, + **kwargs + ): + """List Customer Support Customers # noqa: E501 + + List Customer Support Customers # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.customers_all(async_req=True) + >>> result = thread.get() + + + Keyword Args: + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + cursor (str, none_type): Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.. [optional] + limit (int): Number of records to return. [optional] if omitted the server will use the default value of 20 + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + GetCustomerSupportCustomersResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + return self.customers_all_endpoint.call_with_http_info(**kwargs) + + def customers_delete( + self, + id, + **kwargs + ): + """Delete Customer Support Customer # noqa: E501 + + Delete Customer Support Customer # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.customers_delete(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + DeleteCustomerSupportCustomerResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + return self.customers_delete_endpoint.call_with_http_info(**kwargs) + + def customers_one( + self, + id, + **kwargs + ): + """Get Customer Support Customer # noqa: E501 + + Get Customer Support Customer # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.customers_one(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + GetCustomerSupportCustomerResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + return self.customers_one_endpoint.call_with_http_info(**kwargs) + + def customers_update( + self, + id, + customer_support_customer, + **kwargs + ): + """Update Customer Support Customer # noqa: E501 + + Update Customer Support Customer # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.customers_update(id, customer_support_customer, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + customer_support_customer (CustomerSupportCustomer): + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + UpdateCustomerSupportCustomerResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + kwargs['customer_support_customer'] = \ + customer_support_customer + return self.customers_update_endpoint.call_with_http_info(**kwargs) + diff --git a/src/apideck/api/file_storage_api.py b/src/apideck/api/file_storage_api.py new file mode 100644 index 0000000000..1e19c91c64 --- /dev/null +++ b/src/apideck/api/file_storage_api.py @@ -0,0 +1,4647 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.api_client import ApiClient, Endpoint as _Endpoint +from apideck.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.copy_folder_request import CopyFolderRequest +from apideck.model.create_drive_group_response import CreateDriveGroupResponse +from apideck.model.create_drive_response import CreateDriveResponse +from apideck.model.create_folder_request import CreateFolderRequest +from apideck.model.create_folder_response import CreateFolderResponse +from apideck.model.create_shared_link_response import CreateSharedLinkResponse +from apideck.model.create_upload_session_request import CreateUploadSessionRequest +from apideck.model.create_upload_session_response import CreateUploadSessionResponse +from apideck.model.delete_drive_group_response import DeleteDriveGroupResponse +from apideck.model.delete_drive_response import DeleteDriveResponse +from apideck.model.delete_file_response import DeleteFileResponse +from apideck.model.delete_folder_response import DeleteFolderResponse +from apideck.model.delete_shared_link_response import DeleteSharedLinkResponse +from apideck.model.delete_upload_session_response import DeleteUploadSessionResponse +from apideck.model.drive import Drive +from apideck.model.drive_group import DriveGroup +from apideck.model.drive_groups_filter import DriveGroupsFilter +from apideck.model.drives_filter import DrivesFilter +from apideck.model.files_filter import FilesFilter +from apideck.model.files_search import FilesSearch +from apideck.model.files_sort import FilesSort +from apideck.model.get_drive_group_response import GetDriveGroupResponse +from apideck.model.get_drive_groups_response import GetDriveGroupsResponse +from apideck.model.get_drive_response import GetDriveResponse +from apideck.model.get_drives_response import GetDrivesResponse +from apideck.model.get_file_response import GetFileResponse +from apideck.model.get_files_response import GetFilesResponse +from apideck.model.get_folder_response import GetFolderResponse +from apideck.model.get_shared_link_response import GetSharedLinkResponse +from apideck.model.get_shared_links_response import GetSharedLinksResponse +from apideck.model.get_upload_session_response import GetUploadSessionResponse +from apideck.model.not_found_response import NotFoundResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.shared_link import SharedLink +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.update_drive_group_response import UpdateDriveGroupResponse +from apideck.model.update_drive_response import UpdateDriveResponse +from apideck.model.update_folder_request import UpdateFolderRequest +from apideck.model.update_folder_response import UpdateFolderResponse +from apideck.model.update_shared_link_response import UpdateSharedLinkResponse + + +class FileStorageApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.drive_groups_add_endpoint = _Endpoint( + settings={ + 'response_type': (CreateDriveGroupResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/file-storage/drive-groups', + 'operation_id': 'drive_groups_add', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'drive_group', + 'raw', + 'consumer_id', + 'app_id', + 'service_id', + ], + 'required': [ + 'drive_group', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'drive_group': + (DriveGroup,), + 'raw': + (bool,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + }, + 'attribute_map': { + 'raw': 'raw', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + }, + 'location_map': { + 'drive_group': 'body', + 'raw': 'query', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.drive_groups_all_endpoint = _Endpoint( + settings={ + 'response_type': (GetDriveGroupsResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/file-storage/drive-groups', + 'operation_id': 'drive_groups_all', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'raw', + 'consumer_id', + 'app_id', + 'service_id', + 'cursor', + 'limit', + 'filter', + ], + 'required': [], + 'nullable': [ + 'cursor', + ], + 'enum': [ + ], + 'validation': [ + 'limit', + ] + }, + root_map={ + 'validations': { + ('limit',): { + + 'inclusive_maximum': 200, + 'inclusive_minimum': 1, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'raw': + (bool,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'cursor': + (str, none_type,), + 'limit': + (int,), + 'filter': + (DriveGroupsFilter,), + }, + 'attribute_map': { + 'raw': 'raw', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'cursor': 'cursor', + 'limit': 'limit', + 'filter': 'filter', + }, + 'location_map': { + 'raw': 'query', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'cursor': 'query', + 'limit': 'query', + 'filter': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.drive_groups_delete_endpoint = _Endpoint( + settings={ + 'response_type': (DeleteDriveGroupResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/file-storage/drive-groups/{id}', + 'operation_id': 'drive_groups_delete', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + }, + 'location_map': { + 'id': 'path', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.drive_groups_one_endpoint = _Endpoint( + settings={ + 'response_type': (GetDriveGroupResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/file-storage/drive-groups/{id}', + 'operation_id': 'drive_groups_one', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + }, + 'location_map': { + 'id': 'path', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.drive_groups_update_endpoint = _Endpoint( + settings={ + 'response_type': (UpdateDriveGroupResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/file-storage/drive-groups/{id}', + 'operation_id': 'drive_groups_update', + 'http_method': 'PATCH', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'drive_group', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + ], + 'required': [ + 'id', + 'drive_group', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'drive_group': + (DriveGroup,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + }, + 'location_map': { + 'id': 'path', + 'drive_group': 'body', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.drives_add_endpoint = _Endpoint( + settings={ + 'response_type': (CreateDriveResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/file-storage/drives', + 'operation_id': 'drives_add', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'drive', + 'raw', + 'consumer_id', + 'app_id', + 'service_id', + ], + 'required': [ + 'drive', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'drive': + (Drive,), + 'raw': + (bool,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + }, + 'attribute_map': { + 'raw': 'raw', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + }, + 'location_map': { + 'drive': 'body', + 'raw': 'query', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.drives_all_endpoint = _Endpoint( + settings={ + 'response_type': (GetDrivesResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/file-storage/drives', + 'operation_id': 'drives_all', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'raw', + 'consumer_id', + 'app_id', + 'service_id', + 'cursor', + 'limit', + 'filter', + ], + 'required': [], + 'nullable': [ + 'cursor', + ], + 'enum': [ + ], + 'validation': [ + 'limit', + ] + }, + root_map={ + 'validations': { + ('limit',): { + + 'inclusive_maximum': 200, + 'inclusive_minimum': 1, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'raw': + (bool,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'cursor': + (str, none_type,), + 'limit': + (int,), + 'filter': + (DrivesFilter,), + }, + 'attribute_map': { + 'raw': 'raw', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'cursor': 'cursor', + 'limit': 'limit', + 'filter': 'filter', + }, + 'location_map': { + 'raw': 'query', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'cursor': 'query', + 'limit': 'query', + 'filter': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.drives_delete_endpoint = _Endpoint( + settings={ + 'response_type': (DeleteDriveResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/file-storage/drives/{id}', + 'operation_id': 'drives_delete', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + }, + 'location_map': { + 'id': 'path', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.drives_one_endpoint = _Endpoint( + settings={ + 'response_type': (GetDriveResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/file-storage/drives/{id}', + 'operation_id': 'drives_one', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + }, + 'location_map': { + 'id': 'path', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.drives_update_endpoint = _Endpoint( + settings={ + 'response_type': (UpdateDriveResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/file-storage/drives/{id}', + 'operation_id': 'drives_update', + 'http_method': 'PATCH', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'drive', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + ], + 'required': [ + 'id', + 'drive', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'drive': + (Drive,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + }, + 'location_map': { + 'id': 'path', + 'drive': 'body', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.files_all_endpoint = _Endpoint( + settings={ + 'response_type': (GetFilesResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/file-storage/files', + 'operation_id': 'files_all', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'raw', + 'consumer_id', + 'app_id', + 'service_id', + 'cursor', + 'limit', + 'filter', + 'sort', + ], + 'required': [], + 'nullable': [ + 'cursor', + ], + 'enum': [ + ], + 'validation': [ + 'limit', + ] + }, + root_map={ + 'validations': { + ('limit',): { + + 'inclusive_maximum': 200, + 'inclusive_minimum': 1, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'raw': + (bool,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'cursor': + (str, none_type,), + 'limit': + (int,), + 'filter': + (FilesFilter,), + 'sort': + (FilesSort,), + }, + 'attribute_map': { + 'raw': 'raw', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'cursor': 'cursor', + 'limit': 'limit', + 'filter': 'filter', + 'sort': 'sort', + }, + 'location_map': { + 'raw': 'query', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'cursor': 'query', + 'limit': 'query', + 'filter': 'query', + 'sort': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.files_delete_endpoint = _Endpoint( + settings={ + 'response_type': (DeleteFileResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/file-storage/files/{id}', + 'operation_id': 'files_delete', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + }, + 'location_map': { + 'id': 'path', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.files_download_endpoint = _Endpoint( + settings={ + 'response_type': (file_type,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/file-storage/files/{id}/download', + 'operation_id': 'files_download', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'consumer_id', + 'app_id', + 'service_id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + }, + 'location_map': { + 'id': 'path', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + '*/*', + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.files_one_endpoint = _Endpoint( + settings={ + 'response_type': (GetFileResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/file-storage/files/{id}', + 'operation_id': 'files_one', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + }, + 'location_map': { + 'id': 'path', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.files_search_endpoint = _Endpoint( + settings={ + 'response_type': (GetFilesResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/file-storage/files/search', + 'operation_id': 'files_search', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'files_search', + 'consumer_id', + 'app_id', + 'service_id', + ], + 'required': [ + 'files_search', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'files_search': + (FilesSearch,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + }, + 'attribute_map': { + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + }, + 'location_map': { + 'files_search': 'body', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.folders_add_endpoint = _Endpoint( + settings={ + 'response_type': (CreateFolderResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/file-storage/folders', + 'operation_id': 'folders_add', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'create_folder_request', + 'raw', + 'consumer_id', + 'app_id', + 'service_id', + ], + 'required': [ + 'create_folder_request', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'create_folder_request': + (CreateFolderRequest,), + 'raw': + (bool,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + }, + 'attribute_map': { + 'raw': 'raw', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + }, + 'location_map': { + 'create_folder_request': 'body', + 'raw': 'query', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.folders_copy_endpoint = _Endpoint( + settings={ + 'response_type': (UpdateFolderResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/file-storage/folders/{id}/copy', + 'operation_id': 'folders_copy', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'copy_folder_request', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + ], + 'required': [ + 'id', + 'copy_folder_request', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'copy_folder_request': + (CopyFolderRequest,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + }, + 'location_map': { + 'id': 'path', + 'copy_folder_request': 'body', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.folders_delete_endpoint = _Endpoint( + settings={ + 'response_type': (DeleteFolderResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/file-storage/folders/{id}', + 'operation_id': 'folders_delete', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + }, + 'location_map': { + 'id': 'path', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.folders_one_endpoint = _Endpoint( + settings={ + 'response_type': (GetFolderResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/file-storage/folders/{id}', + 'operation_id': 'folders_one', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + }, + 'location_map': { + 'id': 'path', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.folders_update_endpoint = _Endpoint( + settings={ + 'response_type': (UpdateFolderResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/file-storage/folders/{id}', + 'operation_id': 'folders_update', + 'http_method': 'PATCH', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'update_folder_request', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + ], + 'required': [ + 'id', + 'update_folder_request', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'update_folder_request': + (UpdateFolderRequest,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + }, + 'location_map': { + 'id': 'path', + 'update_folder_request': 'body', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.shared_links_add_endpoint = _Endpoint( + settings={ + 'response_type': (CreateSharedLinkResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/file-storage/shared-links', + 'operation_id': 'shared_links_add', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'shared_link', + 'raw', + 'consumer_id', + 'app_id', + 'service_id', + ], + 'required': [ + 'shared_link', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'shared_link': + (SharedLink,), + 'raw': + (bool,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + }, + 'attribute_map': { + 'raw': 'raw', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + }, + 'location_map': { + 'shared_link': 'body', + 'raw': 'query', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.shared_links_all_endpoint = _Endpoint( + settings={ + 'response_type': (GetSharedLinksResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/file-storage/shared-links', + 'operation_id': 'shared_links_all', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'raw', + 'consumer_id', + 'app_id', + 'service_id', + 'cursor', + 'limit', + ], + 'required': [], + 'nullable': [ + 'cursor', + ], + 'enum': [ + ], + 'validation': [ + 'limit', + ] + }, + root_map={ + 'validations': { + ('limit',): { + + 'inclusive_maximum': 200, + 'inclusive_minimum': 1, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'raw': + (bool,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'cursor': + (str, none_type,), + 'limit': + (int,), + }, + 'attribute_map': { + 'raw': 'raw', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'cursor': 'cursor', + 'limit': 'limit', + }, + 'location_map': { + 'raw': 'query', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'cursor': 'query', + 'limit': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.shared_links_delete_endpoint = _Endpoint( + settings={ + 'response_type': (DeleteSharedLinkResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/file-storage/shared-links/{id}', + 'operation_id': 'shared_links_delete', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + }, + 'location_map': { + 'id': 'path', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.shared_links_one_endpoint = _Endpoint( + settings={ + 'response_type': (GetSharedLinkResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/file-storage/shared-links/{id}', + 'operation_id': 'shared_links_one', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + }, + 'location_map': { + 'id': 'path', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.shared_links_update_endpoint = _Endpoint( + settings={ + 'response_type': (UpdateSharedLinkResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/file-storage/shared-links/{id}', + 'operation_id': 'shared_links_update', + 'http_method': 'PATCH', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'shared_link', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + ], + 'required': [ + 'id', + 'shared_link', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'shared_link': + (SharedLink,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + }, + 'location_map': { + 'id': 'path', + 'shared_link': 'body', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.upload_sessions_add_endpoint = _Endpoint( + settings={ + 'response_type': (CreateUploadSessionResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/file-storage/upload-sessions', + 'operation_id': 'upload_sessions_add', + 'http_method': 'POST', + 'servers': [ + { + 'url': "https://upload.apideck.com", + 'description': "No description provided", + }, + ] + }, + params_map={ + 'all': [ + 'create_upload_session_request', + 'raw', + 'consumer_id', + 'app_id', + 'service_id', + ], + 'required': [ + 'create_upload_session_request', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'create_upload_session_request': + (CreateUploadSessionRequest,), + 'raw': + (bool,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + }, + 'attribute_map': { + 'raw': 'raw', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + }, + 'location_map': { + 'create_upload_session_request': 'body', + 'raw': 'query', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.upload_sessions_delete_endpoint = _Endpoint( + settings={ + 'response_type': (DeleteUploadSessionResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/file-storage/upload-sessions/{id}', + 'operation_id': 'upload_sessions_delete', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + }, + 'location_map': { + 'id': 'path', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.upload_sessions_finish_endpoint = _Endpoint( + settings={ + 'response_type': (GetFileResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/file-storage/upload-sessions/{id}/finish', + 'operation_id': 'upload_sessions_finish', + 'http_method': 'POST', + 'servers': [ + { + 'url': "https://upload.apideck.com", + 'description': "No description provided", + }, + ] + }, + params_map={ + 'all': [ + 'id', + 'raw', + 'consumer_id', + 'app_id', + 'service_id', + 'digest', + 'body', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'raw': + (bool,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'digest': + (str,), + 'body': + (dict,), + }, + 'attribute_map': { + 'id': 'id', + 'raw': 'raw', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'digest': 'digest', + }, + 'location_map': { + 'id': 'path', + 'raw': 'query', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'digest': 'header', + 'body': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.upload_sessions_one_endpoint = _Endpoint( + settings={ + 'response_type': (GetUploadSessionResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/file-storage/upload-sessions/{id}', + 'operation_id': 'upload_sessions_one', + 'http_method': 'GET', + 'servers': [ + { + 'url': "https://upload.apideck.com", + 'description': "No description provided", + }, + ] + }, + params_map={ + 'all': [ + 'id', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + }, + 'location_map': { + 'id': 'path', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def drive_groups_add( + self, + drive_group, + **kwargs + ): + """Create DriveGroup # noqa: E501 + + Create DriveGroup # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.drive_groups_add(drive_group, async_req=True) + >>> result = thread.get() + + Args: + drive_group (DriveGroup): + + Keyword Args: + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + CreateDriveGroupResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['drive_group'] = \ + drive_group + return self.drive_groups_add_endpoint.call_with_http_info(**kwargs) + + def drive_groups_all( + self, + **kwargs + ): + """List DriveGroups # noqa: E501 + + List DriveGroups # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.drive_groups_all(async_req=True) + >>> result = thread.get() + + + Keyword Args: + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + cursor (str, none_type): Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.. [optional] + limit (int): Number of records to return. [optional] if omitted the server will use the default value of 20 + filter (DriveGroupsFilter): Apply filters. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + GetDriveGroupsResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + return self.drive_groups_all_endpoint.call_with_http_info(**kwargs) + + def drive_groups_delete( + self, + id, + **kwargs + ): + """Delete DriveGroup # noqa: E501 + + Delete DriveGroup # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.drive_groups_delete(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + DeleteDriveGroupResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + return self.drive_groups_delete_endpoint.call_with_http_info(**kwargs) + + def drive_groups_one( + self, + id, + **kwargs + ): + """Get DriveGroup # noqa: E501 + + Get DriveGroup # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.drive_groups_one(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + GetDriveGroupResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + return self.drive_groups_one_endpoint.call_with_http_info(**kwargs) + + def drive_groups_update( + self, + id, + drive_group, + **kwargs + ): + """Update DriveGroup # noqa: E501 + + Update DriveGroup # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.drive_groups_update(id, drive_group, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + drive_group (DriveGroup): + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + UpdateDriveGroupResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + kwargs['drive_group'] = \ + drive_group + return self.drive_groups_update_endpoint.call_with_http_info(**kwargs) + + def drives_add( + self, + drive, + **kwargs + ): + """Create Drive # noqa: E501 + + Create Drive # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.drives_add(drive, async_req=True) + >>> result = thread.get() + + Args: + drive (Drive): + + Keyword Args: + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + CreateDriveResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['drive'] = \ + drive + return self.drives_add_endpoint.call_with_http_info(**kwargs) + + def drives_all( + self, + **kwargs + ): + """List Drives # noqa: E501 + + List Drives # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.drives_all(async_req=True) + >>> result = thread.get() + + + Keyword Args: + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + cursor (str, none_type): Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.. [optional] + limit (int): Number of records to return. [optional] if omitted the server will use the default value of 20 + filter (DrivesFilter): Apply filters. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + GetDrivesResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + return self.drives_all_endpoint.call_with_http_info(**kwargs) + + def drives_delete( + self, + id, + **kwargs + ): + """Delete Drive # noqa: E501 + + Delete Drive # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.drives_delete(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + DeleteDriveResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + return self.drives_delete_endpoint.call_with_http_info(**kwargs) + + def drives_one( + self, + id, + **kwargs + ): + """Get Drive # noqa: E501 + + Get Drive # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.drives_one(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + GetDriveResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + return self.drives_one_endpoint.call_with_http_info(**kwargs) + + def drives_update( + self, + id, + drive, + **kwargs + ): + """Update Drive # noqa: E501 + + Update Drive # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.drives_update(id, drive, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + drive (Drive): + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + UpdateDriveResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + kwargs['drive'] = \ + drive + return self.drives_update_endpoint.call_with_http_info(**kwargs) + + def files_all( + self, + **kwargs + ): + """List Files # noqa: E501 + + List Files # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.files_all(async_req=True) + >>> result = thread.get() + + + Keyword Args: + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + cursor (str, none_type): Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.. [optional] + limit (int): Number of records to return. [optional] if omitted the server will use the default value of 20 + filter (FilesFilter): Apply filters. [optional] + sort (FilesSort): Apply sorting. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + GetFilesResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + return self.files_all_endpoint.call_with_http_info(**kwargs) + + def files_delete( + self, + id, + **kwargs + ): + """Delete File # noqa: E501 + + Delete File # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.files_delete(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + DeleteFileResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + return self.files_delete_endpoint.call_with_http_info(**kwargs) + + def files_download( + self, + id, + **kwargs + ): + """Download File # noqa: E501 + + Download File # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.files_download(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + file_type + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + return self.files_download_endpoint.call_with_http_info(**kwargs) + + def files_one( + self, + id, + **kwargs + ): + """Get File # noqa: E501 + + Get File # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.files_one(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + GetFileResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + return self.files_one_endpoint.call_with_http_info(**kwargs) + + def files_search( + self, + files_search, + **kwargs + ): + """Search Files # noqa: E501 + + Search Files # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.files_search(files_search, async_req=True) + >>> result = thread.get() + + Args: + files_search (FilesSearch): + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + GetFilesResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['files_search'] = \ + files_search + return self.files_search_endpoint.call_with_http_info(**kwargs) + + def folders_add( + self, + create_folder_request, + **kwargs + ): + """Create Folder # noqa: E501 + + Create Folder # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.folders_add(create_folder_request, async_req=True) + >>> result = thread.get() + + Args: + create_folder_request (CreateFolderRequest): + + Keyword Args: + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + CreateFolderResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['create_folder_request'] = \ + create_folder_request + return self.folders_add_endpoint.call_with_http_info(**kwargs) + + def folders_copy( + self, + id, + copy_folder_request, + **kwargs + ): + """Copy Folder # noqa: E501 + + Copy Folder # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.folders_copy(id, copy_folder_request, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + copy_folder_request (CopyFolderRequest): + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + UpdateFolderResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + kwargs['copy_folder_request'] = \ + copy_folder_request + return self.folders_copy_endpoint.call_with_http_info(**kwargs) + + def folders_delete( + self, + id, + **kwargs + ): + """Delete Folder # noqa: E501 + + Delete Folder # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.folders_delete(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + DeleteFolderResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + return self.folders_delete_endpoint.call_with_http_info(**kwargs) + + def folders_one( + self, + id, + **kwargs + ): + """Get Folder # noqa: E501 + + Get Folder # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.folders_one(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + GetFolderResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + return self.folders_one_endpoint.call_with_http_info(**kwargs) + + def folders_update( + self, + id, + update_folder_request, + **kwargs + ): + """Rename or move Folder # noqa: E501 + + Rename or move Folder # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.folders_update(id, update_folder_request, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + update_folder_request (UpdateFolderRequest): + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + UpdateFolderResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + kwargs['update_folder_request'] = \ + update_folder_request + return self.folders_update_endpoint.call_with_http_info(**kwargs) + + def shared_links_add( + self, + shared_link, + **kwargs + ): + """Create Shared Link # noqa: E501 + + Create Shared Link # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.shared_links_add(shared_link, async_req=True) + >>> result = thread.get() + + Args: + shared_link (SharedLink): + + Keyword Args: + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + CreateSharedLinkResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['shared_link'] = \ + shared_link + return self.shared_links_add_endpoint.call_with_http_info(**kwargs) + + def shared_links_all( + self, + **kwargs + ): + """List SharedLinks # noqa: E501 + + List SharedLinks # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.shared_links_all(async_req=True) + >>> result = thread.get() + + + Keyword Args: + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + cursor (str, none_type): Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.. [optional] + limit (int): Number of records to return. [optional] if omitted the server will use the default value of 20 + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + GetSharedLinksResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + return self.shared_links_all_endpoint.call_with_http_info(**kwargs) + + def shared_links_delete( + self, + id, + **kwargs + ): + """Delete Shared Link # noqa: E501 + + Delete Shared Link # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.shared_links_delete(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + DeleteSharedLinkResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + return self.shared_links_delete_endpoint.call_with_http_info(**kwargs) + + def shared_links_one( + self, + id, + **kwargs + ): + """Get Shared Link # noqa: E501 + + Get Shared Link # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.shared_links_one(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + GetSharedLinkResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + return self.shared_links_one_endpoint.call_with_http_info(**kwargs) + + def shared_links_update( + self, + id, + shared_link, + **kwargs + ): + """Update Shared Link # noqa: E501 + + Update Shared Link # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.shared_links_update(id, shared_link, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + shared_link (SharedLink): + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + UpdateSharedLinkResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + kwargs['shared_link'] = \ + shared_link + return self.shared_links_update_endpoint.call_with_http_info(**kwargs) + + def upload_sessions_add( + self, + create_upload_session_request, + **kwargs + ): + """Start Upload Session # noqa: E501 + + Start an Upload Session. Upload sessions are used to upload large files, use the [Upload File](#operation/filesUpload) endpoint to upload smaller files (up to 100MB). # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.upload_sessions_add(create_upload_session_request, async_req=True) + >>> result = thread.get() + + Args: + create_upload_session_request (CreateUploadSessionRequest): + + Keyword Args: + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + CreateUploadSessionResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['create_upload_session_request'] = \ + create_upload_session_request + return self.upload_sessions_add_endpoint.call_with_http_info(**kwargs) + + def upload_sessions_delete( + self, + id, + **kwargs + ): + """Abort Upload Session # noqa: E501 + + Abort Upload Session # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.upload_sessions_delete(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + DeleteUploadSessionResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + return self.upload_sessions_delete_endpoint.call_with_http_info(**kwargs) + + def upload_sessions_finish( + self, + id, + **kwargs + ): + """Finish Upload Session # noqa: E501 + + Finish Upload Session. Only call this endpoint after all File parts have been uploaded to [Upload part of File](#operation/uploadSessionsUpload). # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.upload_sessions_finish(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + + Keyword Args: + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + digest (str): The RFC3230 message digest of the uploaded part. Only required for the Box connector. More information on the Box API docs [here](https://developer.box.com/reference/put-files-upload-sessions-id/#param-digest). [optional] + body (dict): [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + GetFileResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + return self.upload_sessions_finish_endpoint.call_with_http_info(**kwargs) + + def upload_sessions_one( + self, + id, + **kwargs + ): + """Get Upload Session # noqa: E501 + + Get Upload Session. Use the `part_size` to split your file into parts. Upload the parts to the [Upload part of File](#operation/uploadSessionsUpload) endpoint. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.upload_sessions_one(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + GetUploadSessionResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + return self.upload_sessions_one_endpoint.call_with_http_info(**kwargs) + diff --git a/src/apideck/api/hris_api.py b/src/apideck/api/hris_api.py new file mode 100644 index 0000000000..13ed4b48b5 --- /dev/null +++ b/src/apideck/api/hris_api.py @@ -0,0 +1,4316 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.api_client import ApiClient, Endpoint as _Endpoint +from apideck.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.create_department_response import CreateDepartmentResponse +from apideck.model.create_employee_response import CreateEmployeeResponse +from apideck.model.create_hris_company_response import CreateHrisCompanyResponse +from apideck.model.create_time_off_request_response import CreateTimeOffRequestResponse +from apideck.model.delete_department_response import DeleteDepartmentResponse +from apideck.model.delete_employee_response import DeleteEmployeeResponse +from apideck.model.delete_hris_company_response import DeleteHrisCompanyResponse +from apideck.model.delete_time_off_request_response import DeleteTimeOffRequestResponse +from apideck.model.department import Department +from apideck.model.employee import Employee +from apideck.model.employees_filter import EmployeesFilter +from apideck.model.get_department_response import GetDepartmentResponse +from apideck.model.get_departments_response import GetDepartmentsResponse +from apideck.model.get_employee_payroll_response import GetEmployeePayrollResponse +from apideck.model.get_employee_payrolls_response import GetEmployeePayrollsResponse +from apideck.model.get_employee_response import GetEmployeeResponse +from apideck.model.get_employee_schedules_response import GetEmployeeSchedulesResponse +from apideck.model.get_employees_response import GetEmployeesResponse +from apideck.model.get_hris_companies_response import GetHrisCompaniesResponse +from apideck.model.get_hris_company_response import GetHrisCompanyResponse +from apideck.model.get_hris_job_response import GetHrisJobResponse +from apideck.model.get_hris_jobs_response import GetHrisJobsResponse +from apideck.model.get_payroll_response import GetPayrollResponse +from apideck.model.get_payrolls_response import GetPayrollsResponse +from apideck.model.get_time_off_request_response import GetTimeOffRequestResponse +from apideck.model.get_time_off_requests_response import GetTimeOffRequestsResponse +from apideck.model.hris_company import HrisCompany +from apideck.model.not_found_response import NotFoundResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.payrolls_filter import PayrollsFilter +from apideck.model.time_off_request import TimeOffRequest +from apideck.model.time_off_requests_filter import TimeOffRequestsFilter +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.update_department_response import UpdateDepartmentResponse +from apideck.model.update_employee_response import UpdateEmployeeResponse +from apideck.model.update_hris_company_response import UpdateHrisCompanyResponse +from apideck.model.update_time_off_request_response import UpdateTimeOffRequestResponse + + +class HrisApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.companies_add_endpoint = _Endpoint( + settings={ + 'response_type': (CreateHrisCompanyResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/hris/companies', + 'operation_id': 'companies_add', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'hris_company', + 'raw', + 'consumer_id', + 'app_id', + 'service_id', + ], + 'required': [ + 'hris_company', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'hris_company': + (HrisCompany,), + 'raw': + (bool,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + }, + 'attribute_map': { + 'raw': 'raw', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + }, + 'location_map': { + 'hris_company': 'body', + 'raw': 'query', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.companies_all_endpoint = _Endpoint( + settings={ + 'response_type': (GetHrisCompaniesResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/hris/companies', + 'operation_id': 'companies_all', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'raw', + 'consumer_id', + 'app_id', + 'service_id', + 'cursor', + 'limit', + ], + 'required': [], + 'nullable': [ + 'cursor', + ], + 'enum': [ + ], + 'validation': [ + 'limit', + ] + }, + root_map={ + 'validations': { + ('limit',): { + + 'inclusive_maximum': 200, + 'inclusive_minimum': 1, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'raw': + (bool,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'cursor': + (str, none_type,), + 'limit': + (int,), + }, + 'attribute_map': { + 'raw': 'raw', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'cursor': 'cursor', + 'limit': 'limit', + }, + 'location_map': { + 'raw': 'query', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'cursor': 'query', + 'limit': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.companies_delete_endpoint = _Endpoint( + settings={ + 'response_type': (DeleteHrisCompanyResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/hris/companies/{id}', + 'operation_id': 'companies_delete', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + }, + 'location_map': { + 'id': 'path', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.companies_one_endpoint = _Endpoint( + settings={ + 'response_type': (GetHrisCompanyResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/hris/companies/{id}', + 'operation_id': 'companies_one', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + }, + 'location_map': { + 'id': 'path', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.companies_update_endpoint = _Endpoint( + settings={ + 'response_type': (UpdateHrisCompanyResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/hris/companies/{id}', + 'operation_id': 'companies_update', + 'http_method': 'PATCH', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'hris_company', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + ], + 'required': [ + 'id', + 'hris_company', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'hris_company': + (HrisCompany,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + }, + 'location_map': { + 'id': 'path', + 'hris_company': 'body', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.departments_add_endpoint = _Endpoint( + settings={ + 'response_type': (CreateDepartmentResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/hris/departments', + 'operation_id': 'departments_add', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'department', + 'raw', + 'consumer_id', + 'app_id', + 'service_id', + ], + 'required': [ + 'department', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'department': + (Department,), + 'raw': + (bool,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + }, + 'attribute_map': { + 'raw': 'raw', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + }, + 'location_map': { + 'department': 'body', + 'raw': 'query', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.departments_all_endpoint = _Endpoint( + settings={ + 'response_type': (GetDepartmentsResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/hris/departments', + 'operation_id': 'departments_all', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'raw', + 'consumer_id', + 'app_id', + 'service_id', + 'cursor', + 'limit', + ], + 'required': [], + 'nullable': [ + 'cursor', + ], + 'enum': [ + ], + 'validation': [ + 'limit', + ] + }, + root_map={ + 'validations': { + ('limit',): { + + 'inclusive_maximum': 200, + 'inclusive_minimum': 1, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'raw': + (bool,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'cursor': + (str, none_type,), + 'limit': + (int,), + }, + 'attribute_map': { + 'raw': 'raw', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'cursor': 'cursor', + 'limit': 'limit', + }, + 'location_map': { + 'raw': 'query', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'cursor': 'query', + 'limit': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.departments_delete_endpoint = _Endpoint( + settings={ + 'response_type': (DeleteDepartmentResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/hris/departments/{id}', + 'operation_id': 'departments_delete', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + }, + 'location_map': { + 'id': 'path', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.departments_one_endpoint = _Endpoint( + settings={ + 'response_type': (GetDepartmentResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/hris/departments/{id}', + 'operation_id': 'departments_one', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + }, + 'location_map': { + 'id': 'path', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.departments_update_endpoint = _Endpoint( + settings={ + 'response_type': (UpdateDepartmentResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/hris/departments/{id}', + 'operation_id': 'departments_update', + 'http_method': 'PATCH', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'department', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + ], + 'required': [ + 'id', + 'department', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'department': + (Department,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + }, + 'location_map': { + 'id': 'path', + 'department': 'body', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.employee_payrolls_all_endpoint = _Endpoint( + settings={ + 'response_type': (GetEmployeePayrollsResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/hris/payrolls/employees/{employee_id}', + 'operation_id': 'employee_payrolls_all', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'employee_id', + 'raw', + 'consumer_id', + 'app_id', + 'service_id', + 'filter', + ], + 'required': [ + 'employee_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'employee_id': + (str,), + 'raw': + (bool,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'filter': + (PayrollsFilter,), + }, + 'attribute_map': { + 'employee_id': 'employee_id', + 'raw': 'raw', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'filter': 'filter', + }, + 'location_map': { + 'employee_id': 'path', + 'raw': 'query', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'filter': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.employee_payrolls_one_endpoint = _Endpoint( + settings={ + 'response_type': (GetEmployeePayrollResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/hris/payrolls/employees/{employee_id}/payrolls/{payroll_id}', + 'operation_id': 'employee_payrolls_one', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'payroll_id', + 'employee_id', + 'raw', + 'consumer_id', + 'app_id', + 'service_id', + ], + 'required': [ + 'payroll_id', + 'employee_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'payroll_id': + (str,), + 'employee_id': + (str,), + 'raw': + (bool,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + }, + 'attribute_map': { + 'payroll_id': 'payroll_id', + 'employee_id': 'employee_id', + 'raw': 'raw', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + }, + 'location_map': { + 'payroll_id': 'path', + 'employee_id': 'path', + 'raw': 'query', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.employee_schedules_all_endpoint = _Endpoint( + settings={ + 'response_type': (GetEmployeeSchedulesResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/hris/schedules/employees/{employee_id}', + 'operation_id': 'employee_schedules_all', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'employee_id', + 'raw', + 'consumer_id', + 'app_id', + 'service_id', + ], + 'required': [ + 'employee_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'employee_id': + (str,), + 'raw': + (bool,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + }, + 'attribute_map': { + 'employee_id': 'employee_id', + 'raw': 'raw', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + }, + 'location_map': { + 'employee_id': 'path', + 'raw': 'query', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.employees_add_endpoint = _Endpoint( + settings={ + 'response_type': (CreateEmployeeResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/hris/employees', + 'operation_id': 'employees_add', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'employee', + 'raw', + 'consumer_id', + 'app_id', + 'service_id', + ], + 'required': [ + 'employee', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'employee': + (Employee,), + 'raw': + (bool,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + }, + 'attribute_map': { + 'raw': 'raw', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + }, + 'location_map': { + 'employee': 'body', + 'raw': 'query', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.employees_all_endpoint = _Endpoint( + settings={ + 'response_type': (GetEmployeesResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/hris/employees', + 'operation_id': 'employees_all', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'raw', + 'consumer_id', + 'app_id', + 'service_id', + 'cursor', + 'limit', + 'filter', + ], + 'required': [], + 'nullable': [ + 'cursor', + ], + 'enum': [ + ], + 'validation': [ + 'limit', + ] + }, + root_map={ + 'validations': { + ('limit',): { + + 'inclusive_maximum': 200, + 'inclusive_minimum': 1, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'raw': + (bool,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'cursor': + (str, none_type,), + 'limit': + (int,), + 'filter': + (EmployeesFilter,), + }, + 'attribute_map': { + 'raw': 'raw', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'cursor': 'cursor', + 'limit': 'limit', + 'filter': 'filter', + }, + 'location_map': { + 'raw': 'query', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'cursor': 'query', + 'limit': 'query', + 'filter': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.employees_delete_endpoint = _Endpoint( + settings={ + 'response_type': (DeleteEmployeeResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/hris/employees/{id}', + 'operation_id': 'employees_delete', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + }, + 'location_map': { + 'id': 'path', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.employees_one_endpoint = _Endpoint( + settings={ + 'response_type': (GetEmployeeResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/hris/employees/{id}', + 'operation_id': 'employees_one', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + }, + 'location_map': { + 'id': 'path', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.employees_update_endpoint = _Endpoint( + settings={ + 'response_type': (UpdateEmployeeResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/hris/employees/{id}', + 'operation_id': 'employees_update', + 'http_method': 'PATCH', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'employee', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + ], + 'required': [ + 'id', + 'employee', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'employee': + (Employee,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + }, + 'location_map': { + 'id': 'path', + 'employee': 'body', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.jobs_all_endpoint = _Endpoint( + settings={ + 'response_type': (GetHrisJobsResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/hris/jobs/employees/{employee_id}', + 'operation_id': 'jobs_all', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'employee_id', + 'raw', + 'consumer_id', + 'app_id', + 'service_id', + ], + 'required': [ + 'employee_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'employee_id': + (str,), + 'raw': + (bool,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + }, + 'attribute_map': { + 'employee_id': 'employee_id', + 'raw': 'raw', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + }, + 'location_map': { + 'employee_id': 'path', + 'raw': 'query', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.jobs_one_endpoint = _Endpoint( + settings={ + 'response_type': (GetHrisJobResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/hris/jobs/employees/{employee_id}/jobs/{job_id}', + 'operation_id': 'jobs_one', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'job_id', + 'employee_id', + 'raw', + 'consumer_id', + 'app_id', + 'service_id', + ], + 'required': [ + 'job_id', + 'employee_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'job_id': + (str,), + 'employee_id': + (str,), + 'raw': + (bool,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + }, + 'attribute_map': { + 'job_id': 'job_id', + 'employee_id': 'employee_id', + 'raw': 'raw', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + }, + 'location_map': { + 'job_id': 'path', + 'employee_id': 'path', + 'raw': 'query', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.payrolls_all_endpoint = _Endpoint( + settings={ + 'response_type': (GetPayrollsResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/hris/payrolls', + 'operation_id': 'payrolls_all', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'raw', + 'consumer_id', + 'app_id', + 'service_id', + 'filter', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'raw': + (bool,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'filter': + (PayrollsFilter,), + }, + 'attribute_map': { + 'raw': 'raw', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'filter': 'filter', + }, + 'location_map': { + 'raw': 'query', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'filter': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.payrolls_one_endpoint = _Endpoint( + settings={ + 'response_type': (GetPayrollResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/hris/payrolls/{payroll_id}', + 'operation_id': 'payrolls_one', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'payroll_id', + 'raw', + 'consumer_id', + 'app_id', + 'service_id', + ], + 'required': [ + 'payroll_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'payroll_id': + (str,), + 'raw': + (bool,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + }, + 'attribute_map': { + 'payroll_id': 'payroll_id', + 'raw': 'raw', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + }, + 'location_map': { + 'payroll_id': 'path', + 'raw': 'query', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.time_off_requests_add_endpoint = _Endpoint( + settings={ + 'response_type': (CreateTimeOffRequestResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/hris/time-off-requests', + 'operation_id': 'time_off_requests_add', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'time_off_request', + 'raw', + 'consumer_id', + 'app_id', + 'service_id', + ], + 'required': [ + 'time_off_request', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'time_off_request': + (TimeOffRequest,), + 'raw': + (bool,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + }, + 'attribute_map': { + 'raw': 'raw', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + }, + 'location_map': { + 'time_off_request': 'body', + 'raw': 'query', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.time_off_requests_all_endpoint = _Endpoint( + settings={ + 'response_type': (GetTimeOffRequestsResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/hris/time-off-requests', + 'operation_id': 'time_off_requests_all', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'raw', + 'consumer_id', + 'app_id', + 'service_id', + 'cursor', + 'limit', + 'filter', + ], + 'required': [], + 'nullable': [ + 'cursor', + ], + 'enum': [ + ], + 'validation': [ + 'limit', + ] + }, + root_map={ + 'validations': { + ('limit',): { + + 'inclusive_maximum': 200, + 'inclusive_minimum': 1, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'raw': + (bool,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'cursor': + (str, none_type,), + 'limit': + (int,), + 'filter': + (TimeOffRequestsFilter,), + }, + 'attribute_map': { + 'raw': 'raw', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'cursor': 'cursor', + 'limit': 'limit', + 'filter': 'filter', + }, + 'location_map': { + 'raw': 'query', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'cursor': 'query', + 'limit': 'query', + 'filter': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.time_off_requests_delete_endpoint = _Endpoint( + settings={ + 'response_type': (DeleteTimeOffRequestResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/hris/time-off-requests/{id}', + 'operation_id': 'time_off_requests_delete', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + }, + 'location_map': { + 'id': 'path', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.time_off_requests_one_endpoint = _Endpoint( + settings={ + 'response_type': (GetTimeOffRequestResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/hris/time-off-requests/{id}', + 'operation_id': 'time_off_requests_one', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + }, + 'location_map': { + 'id': 'path', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.time_off_requests_update_endpoint = _Endpoint( + settings={ + 'response_type': (UpdateTimeOffRequestResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/hris/time-off-requests/{id}', + 'operation_id': 'time_off_requests_update', + 'http_method': 'PATCH', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'time_off_request', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + ], + 'required': [ + 'id', + 'time_off_request', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'time_off_request': + (TimeOffRequest,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + }, + 'location_map': { + 'id': 'path', + 'time_off_request': 'body', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + + def companies_add( + self, + hris_company, + **kwargs + ): + """Create Company # noqa: E501 + + Create Company # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.companies_add(hris_company, async_req=True) + >>> result = thread.get() + + Args: + hris_company (HrisCompany): + + Keyword Args: + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + CreateHrisCompanyResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['hris_company'] = \ + hris_company + return self.companies_add_endpoint.call_with_http_info(**kwargs) + + def companies_all( + self, + **kwargs + ): + """List Companies # noqa: E501 + + List Companies # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.companies_all(async_req=True) + >>> result = thread.get() + + + Keyword Args: + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + cursor (str, none_type): Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.. [optional] + limit (int): Number of records to return. [optional] if omitted the server will use the default value of 20 + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + GetHrisCompaniesResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + return self.companies_all_endpoint.call_with_http_info(**kwargs) + + def companies_delete( + self, + id, + **kwargs + ): + """Delete Company # noqa: E501 + + Delete Company # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.companies_delete(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + DeleteHrisCompanyResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + return self.companies_delete_endpoint.call_with_http_info(**kwargs) + + def companies_one( + self, + id, + **kwargs + ): + """Get Company # noqa: E501 + + Get Company # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.companies_one(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + GetHrisCompanyResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + return self.companies_one_endpoint.call_with_http_info(**kwargs) + + def companies_update( + self, + id, + hris_company, + **kwargs + ): + """Update Company # noqa: E501 + + Update Company # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.companies_update(id, hris_company, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + hris_company (HrisCompany): + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + UpdateHrisCompanyResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + kwargs['hris_company'] = \ + hris_company + return self.companies_update_endpoint.call_with_http_info(**kwargs) + + def departments_add( + self, + department, + **kwargs + ): + """Create Department # noqa: E501 + + Create Department # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.departments_add(department, async_req=True) + >>> result = thread.get() + + Args: + department (Department): + + Keyword Args: + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + CreateDepartmentResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['department'] = \ + department + return self.departments_add_endpoint.call_with_http_info(**kwargs) + + def departments_all( + self, + **kwargs + ): + """List Departments # noqa: E501 + + List Departments # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.departments_all(async_req=True) + >>> result = thread.get() + + + Keyword Args: + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + cursor (str, none_type): Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.. [optional] + limit (int): Number of records to return. [optional] if omitted the server will use the default value of 20 + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + GetDepartmentsResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + return self.departments_all_endpoint.call_with_http_info(**kwargs) + + def departments_delete( + self, + id, + **kwargs + ): + """Delete Department # noqa: E501 + + Delete Department # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.departments_delete(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + DeleteDepartmentResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + return self.departments_delete_endpoint.call_with_http_info(**kwargs) + + def departments_one( + self, + id, + **kwargs + ): + """Get Department # noqa: E501 + + Get Department # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.departments_one(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + GetDepartmentResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + return self.departments_one_endpoint.call_with_http_info(**kwargs) + + def departments_update( + self, + id, + department, + **kwargs + ): + """Update Department # noqa: E501 + + Update Department # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.departments_update(id, department, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + department (Department): + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + UpdateDepartmentResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + kwargs['department'] = \ + department + return self.departments_update_endpoint.call_with_http_info(**kwargs) + + def employee_payrolls_all( + self, + employee_id, + **kwargs + ): + """List Employee Payrolls # noqa: E501 + + List payrolls for employee # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.employee_payrolls_all(employee_id, async_req=True) + >>> result = thread.get() + + Args: + employee_id (str): ID of the employee you are acting upon. + + Keyword Args: + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + filter (PayrollsFilter): Apply filters. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + GetEmployeePayrollsResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['employee_id'] = \ + employee_id + return self.employee_payrolls_all_endpoint.call_with_http_info(**kwargs) + + def employee_payrolls_one( + self, + payroll_id, + employee_id, + **kwargs + ): + """Get Employee Payroll # noqa: E501 + + Get payroll for employee # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.employee_payrolls_one(payroll_id, employee_id, async_req=True) + >>> result = thread.get() + + Args: + payroll_id (str): ID of the payroll you are acting upon. + employee_id (str): ID of the employee you are acting upon. + + Keyword Args: + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + GetEmployeePayrollResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['payroll_id'] = \ + payroll_id + kwargs['employee_id'] = \ + employee_id + return self.employee_payrolls_one_endpoint.call_with_http_info(**kwargs) + + def employee_schedules_all( + self, + employee_id, + **kwargs + ): + """List Employee Schedules # noqa: E501 + + List schedules for employee, a schedule is a work pattern, not the actual worked hours, for an employee. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.employee_schedules_all(employee_id, async_req=True) + >>> result = thread.get() + + Args: + employee_id (str): ID of the employee you are acting upon. + + Keyword Args: + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + GetEmployeeSchedulesResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['employee_id'] = \ + employee_id + return self.employee_schedules_all_endpoint.call_with_http_info(**kwargs) + + def employees_add( + self, + employee, + **kwargs + ): + """Create Employee # noqa: E501 + + Create Employee # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.employees_add(employee, async_req=True) + >>> result = thread.get() + + Args: + employee (Employee): + + Keyword Args: + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + CreateEmployeeResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['employee'] = \ + employee + return self.employees_add_endpoint.call_with_http_info(**kwargs) + + def employees_all( + self, + **kwargs + ): + """List Employees # noqa: E501 + + List Employees # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.employees_all(async_req=True) + >>> result = thread.get() + + + Keyword Args: + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + cursor (str, none_type): Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.. [optional] + limit (int): Number of records to return. [optional] if omitted the server will use the default value of 20 + filter (EmployeesFilter): Apply filters. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + GetEmployeesResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + return self.employees_all_endpoint.call_with_http_info(**kwargs) + + def employees_delete( + self, + id, + **kwargs + ): + """Delete Employee # noqa: E501 + + Delete Employee # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.employees_delete(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + DeleteEmployeeResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + return self.employees_delete_endpoint.call_with_http_info(**kwargs) + + def employees_one( + self, + id, + **kwargs + ): + """Get Employee # noqa: E501 + + Get Employee # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.employees_one(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + GetEmployeeResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + return self.employees_one_endpoint.call_with_http_info(**kwargs) + + def employees_update( + self, + id, + employee, + **kwargs + ): + """Update Employee # noqa: E501 + + Update Employee # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.employees_update(id, employee, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + employee (Employee): + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + UpdateEmployeeResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + kwargs['employee'] = \ + employee + return self.employees_update_endpoint.call_with_http_info(**kwargs) + + def jobs_all( + self, + employee_id, + **kwargs + ): + """List Jobs # noqa: E501 + + List Jobs for employee. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.jobs_all(employee_id, async_req=True) + >>> result = thread.get() + + Args: + employee_id (str): ID of the employee you are acting upon. + + Keyword Args: + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + GetHrisJobsResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['employee_id'] = \ + employee_id + return self.jobs_all_endpoint.call_with_http_info(**kwargs) + + def jobs_one( + self, + job_id, + employee_id, + **kwargs + ): + """One Job # noqa: E501 + + A Job for employee. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.jobs_one(job_id, employee_id, async_req=True) + >>> result = thread.get() + + Args: + job_id (str): ID of the job you are acting upon. + employee_id (str): ID of the employee you are acting upon. + + Keyword Args: + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + GetHrisJobResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['job_id'] = \ + job_id + kwargs['employee_id'] = \ + employee_id + return self.jobs_one_endpoint.call_with_http_info(**kwargs) + + def payrolls_all( + self, + **kwargs + ): + """List Payroll # noqa: E501 + + List Payroll # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.payrolls_all(async_req=True) + >>> result = thread.get() + + + Keyword Args: + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + filter (PayrollsFilter): Apply filters. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + GetPayrollsResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + return self.payrolls_all_endpoint.call_with_http_info(**kwargs) + + def payrolls_one( + self, + payroll_id, + **kwargs + ): + """Get Payroll # noqa: E501 + + Get Payroll # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.payrolls_one(payroll_id, async_req=True) + >>> result = thread.get() + + Args: + payroll_id (str): ID of the payroll you are acting upon. + + Keyword Args: + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + GetPayrollResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['payroll_id'] = \ + payroll_id + return self.payrolls_one_endpoint.call_with_http_info(**kwargs) + + def time_off_requests_add( + self, + time_off_request, + **kwargs + ): + """Create Time Off Request # noqa: E501 + + Create Time Off Request # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.time_off_requests_add(time_off_request, async_req=True) + >>> result = thread.get() + + Args: + time_off_request (TimeOffRequest): + + Keyword Args: + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + CreateTimeOffRequestResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['time_off_request'] = \ + time_off_request + return self.time_off_requests_add_endpoint.call_with_http_info(**kwargs) + + def time_off_requests_all( + self, + **kwargs + ): + """List Time Off Requests # noqa: E501 + + List Time Off Requests # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.time_off_requests_all(async_req=True) + >>> result = thread.get() + + + Keyword Args: + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + cursor (str, none_type): Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.. [optional] + limit (int): Number of records to return. [optional] if omitted the server will use the default value of 20 + filter (TimeOffRequestsFilter): Apply filters. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + GetTimeOffRequestsResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + return self.time_off_requests_all_endpoint.call_with_http_info(**kwargs) + + def time_off_requests_delete( + self, + id, + **kwargs + ): + """Delete Time Off Request # noqa: E501 + + Delete Time Off Request # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.time_off_requests_delete(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + DeleteTimeOffRequestResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + return self.time_off_requests_delete_endpoint.call_with_http_info(**kwargs) + + def time_off_requests_one( + self, + id, + **kwargs + ): + """Get Time Off Request # noqa: E501 + + Get Time Off Request # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.time_off_requests_one(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + GetTimeOffRequestResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + return self.time_off_requests_one_endpoint.call_with_http_info(**kwargs) + + def time_off_requests_update( + self, + id, + time_off_request, + **kwargs + ): + """Update Time Off Request # noqa: E501 + + Update Time Off Request # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.time_off_requests_update(id, time_off_request, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + time_off_request (TimeOffRequest): + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + UpdateTimeOffRequestResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + kwargs['time_off_request'] = \ + time_off_request + return self.time_off_requests_update_endpoint.call_with_http_info(**kwargs) + diff --git a/src/apideck/api/lead_api.py b/src/apideck/api/lead_api.py new file mode 100644 index 0000000000..28ed1a4099 --- /dev/null +++ b/src/apideck/api/lead_api.py @@ -0,0 +1,847 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.api_client import ApiClient, Endpoint as _Endpoint +from apideck.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.create_lead_response import CreateLeadResponse +from apideck.model.delete_lead_response import DeleteLeadResponse +from apideck.model.get_lead_response import GetLeadResponse +from apideck.model.get_leads_response import GetLeadsResponse +from apideck.model.lead import Lead +from apideck.model.leads_filter import LeadsFilter +from apideck.model.leads_sort import LeadsSort +from apideck.model.not_found_response import NotFoundResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.update_lead_response import UpdateLeadResponse + + +class LeadApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.leads_add_endpoint = _Endpoint( + settings={ + 'response_type': (CreateLeadResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/lead/leads', + 'operation_id': 'leads_add', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'lead', + 'raw', + 'consumer_id', + 'app_id', + 'service_id', + ], + 'required': [ + 'lead', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'lead': + (Lead,), + 'raw': + (bool,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + }, + 'attribute_map': { + 'raw': 'raw', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + }, + 'location_map': { + 'lead': 'body', + 'raw': 'query', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.leads_all_endpoint = _Endpoint( + settings={ + 'response_type': (GetLeadsResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/lead/leads', + 'operation_id': 'leads_all', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'raw', + 'consumer_id', + 'app_id', + 'service_id', + 'cursor', + 'limit', + 'filter', + 'sort', + ], + 'required': [], + 'nullable': [ + 'cursor', + ], + 'enum': [ + ], + 'validation': [ + 'limit', + ] + }, + root_map={ + 'validations': { + ('limit',): { + + 'inclusive_maximum': 200, + 'inclusive_minimum': 1, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'raw': + (bool,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'cursor': + (str, none_type,), + 'limit': + (int,), + 'filter': + (LeadsFilter,), + 'sort': + (LeadsSort,), + }, + 'attribute_map': { + 'raw': 'raw', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'cursor': 'cursor', + 'limit': 'limit', + 'filter': 'filter', + 'sort': 'sort', + }, + 'location_map': { + 'raw': 'query', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'cursor': 'query', + 'limit': 'query', + 'filter': 'query', + 'sort': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.leads_delete_endpoint = _Endpoint( + settings={ + 'response_type': (DeleteLeadResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/lead/leads/{id}', + 'operation_id': 'leads_delete', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + }, + 'location_map': { + 'id': 'path', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.leads_one_endpoint = _Endpoint( + settings={ + 'response_type': (GetLeadResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/lead/leads/{id}', + 'operation_id': 'leads_one', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + }, + 'location_map': { + 'id': 'path', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.leads_update_endpoint = _Endpoint( + settings={ + 'response_type': (UpdateLeadResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/lead/leads/{id}', + 'operation_id': 'leads_update', + 'http_method': 'PATCH', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'lead', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + ], + 'required': [ + 'id', + 'lead', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'lead': + (Lead,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + }, + 'location_map': { + 'id': 'path', + 'lead': 'body', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + + def leads_add( + self, + lead, + **kwargs + ): + """Create lead # noqa: E501 + + Create lead # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.leads_add(lead, async_req=True) + >>> result = thread.get() + + Args: + lead (Lead): + + Keyword Args: + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + CreateLeadResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['lead'] = \ + lead + return self.leads_add_endpoint.call_with_http_info(**kwargs) + + def leads_all( + self, + **kwargs + ): + """List leads # noqa: E501 + + List leads # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.leads_all(async_req=True) + >>> result = thread.get() + + + Keyword Args: + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + cursor (str, none_type): Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.. [optional] + limit (int): Number of records to return. [optional] if omitted the server will use the default value of 20 + filter (LeadsFilter): Apply filters. [optional] + sort (LeadsSort): Apply sorting. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + GetLeadsResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + return self.leads_all_endpoint.call_with_http_info(**kwargs) + + def leads_delete( + self, + id, + **kwargs + ): + """Delete lead # noqa: E501 + + Delete lead # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.leads_delete(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + DeleteLeadResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + return self.leads_delete_endpoint.call_with_http_info(**kwargs) + + def leads_one( + self, + id, + **kwargs + ): + """Get lead # noqa: E501 + + Get lead # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.leads_one(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + GetLeadResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + return self.leads_one_endpoint.call_with_http_info(**kwargs) + + def leads_update( + self, + id, + lead, + **kwargs + ): + """Update lead # noqa: E501 + + Update lead # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.leads_update(id, lead, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + lead (Lead): + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + UpdateLeadResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + kwargs['lead'] = \ + lead + return self.leads_update_endpoint.call_with_http_info(**kwargs) + diff --git a/src/apideck/api/pos_api.py b/src/apideck/api/pos_api.py new file mode 100644 index 0000000000..7c49b2d3be --- /dev/null +++ b/src/apideck/api/pos_api.py @@ -0,0 +1,7336 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.api_client import ApiClient, Endpoint as _Endpoint +from apideck.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.create_item_response import CreateItemResponse +from apideck.model.create_location_response import CreateLocationResponse +from apideck.model.create_merchant_response import CreateMerchantResponse +from apideck.model.create_modifier_group_response import CreateModifierGroupResponse +from apideck.model.create_modifier_response import CreateModifierResponse +from apideck.model.create_order_response import CreateOrderResponse +from apideck.model.create_order_type_response import CreateOrderTypeResponse +from apideck.model.create_pos_payment_response import CreatePosPaymentResponse +from apideck.model.create_tender_response import CreateTenderResponse +from apideck.model.delete_item_response import DeleteItemResponse +from apideck.model.delete_location_response import DeleteLocationResponse +from apideck.model.delete_merchant_response import DeleteMerchantResponse +from apideck.model.delete_modifier_group_response import DeleteModifierGroupResponse +from apideck.model.delete_modifier_response import DeleteModifierResponse +from apideck.model.delete_order_response import DeleteOrderResponse +from apideck.model.delete_order_type_response import DeleteOrderTypeResponse +from apideck.model.delete_pos_payment_response import DeletePosPaymentResponse +from apideck.model.delete_tender_response import DeleteTenderResponse +from apideck.model.get_item_response import GetItemResponse +from apideck.model.get_items_response import GetItemsResponse +from apideck.model.get_location_response import GetLocationResponse +from apideck.model.get_locations_response import GetLocationsResponse +from apideck.model.get_merchant_response import GetMerchantResponse +from apideck.model.get_merchants_response import GetMerchantsResponse +from apideck.model.get_modifier_group_response import GetModifierGroupResponse +from apideck.model.get_modifier_groups_response import GetModifierGroupsResponse +from apideck.model.get_modifier_response import GetModifierResponse +from apideck.model.get_modifiers_response import GetModifiersResponse +from apideck.model.get_order_response import GetOrderResponse +from apideck.model.get_order_type_response import GetOrderTypeResponse +from apideck.model.get_order_types_response import GetOrderTypesResponse +from apideck.model.get_orders_response import GetOrdersResponse +from apideck.model.get_pos_payment_response import GetPosPaymentResponse +from apideck.model.get_pos_payments_response import GetPosPaymentsResponse +from apideck.model.get_tender_response import GetTenderResponse +from apideck.model.get_tenders_response import GetTendersResponse +from apideck.model.item import Item +from apideck.model.location import Location +from apideck.model.merchant import Merchant +from apideck.model.modifier import Modifier +from apideck.model.modifier_group import ModifierGroup +from apideck.model.modifier_group_filter import ModifierGroupFilter +from apideck.model.not_found_response import NotFoundResponse +from apideck.model.order import Order +from apideck.model.order_type import OrderType +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.pos_payment import PosPayment +from apideck.model.tender import Tender +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.update_item_response import UpdateItemResponse +from apideck.model.update_location_response import UpdateLocationResponse +from apideck.model.update_merchant_response import UpdateMerchantResponse +from apideck.model.update_modifier_group_response import UpdateModifierGroupResponse +from apideck.model.update_modifier_response import UpdateModifierResponse +from apideck.model.update_order_response import UpdateOrderResponse +from apideck.model.update_order_type_response import UpdateOrderTypeResponse +from apideck.model.update_pos_payment_response import UpdatePosPaymentResponse +from apideck.model.update_tender_response import UpdateTenderResponse + + +class PosApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.items_add_endpoint = _Endpoint( + settings={ + 'response_type': (CreateItemResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/pos/items', + 'operation_id': 'items_add', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'item', + 'raw', + 'consumer_id', + 'app_id', + 'service_id', + ], + 'required': [ + 'item', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'item': + (Item,), + 'raw': + (bool,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + }, + 'attribute_map': { + 'raw': 'raw', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + }, + 'location_map': { + 'item': 'body', + 'raw': 'query', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.items_all_endpoint = _Endpoint( + settings={ + 'response_type': (GetItemsResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/pos/items', + 'operation_id': 'items_all', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'raw', + 'consumer_id', + 'app_id', + 'service_id', + 'cursor', + 'limit', + ], + 'required': [], + 'nullable': [ + 'cursor', + ], + 'enum': [ + ], + 'validation': [ + 'limit', + ] + }, + root_map={ + 'validations': { + ('limit',): { + + 'inclusive_maximum': 200, + 'inclusive_minimum': 1, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'raw': + (bool,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'cursor': + (str, none_type,), + 'limit': + (int,), + }, + 'attribute_map': { + 'raw': 'raw', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'cursor': 'cursor', + 'limit': 'limit', + }, + 'location_map': { + 'raw': 'query', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'cursor': 'query', + 'limit': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.items_delete_endpoint = _Endpoint( + settings={ + 'response_type': (DeleteItemResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/pos/items/{id}', + 'operation_id': 'items_delete', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + }, + 'location_map': { + 'id': 'path', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.items_one_endpoint = _Endpoint( + settings={ + 'response_type': (GetItemResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/pos/items/{id}', + 'operation_id': 'items_one', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + }, + 'location_map': { + 'id': 'path', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.items_update_endpoint = _Endpoint( + settings={ + 'response_type': (UpdateItemResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/pos/items/{id}', + 'operation_id': 'items_update', + 'http_method': 'PATCH', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'item', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + ], + 'required': [ + 'id', + 'item', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'item': + (Item,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + }, + 'location_map': { + 'id': 'path', + 'item': 'body', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.locations_add_endpoint = _Endpoint( + settings={ + 'response_type': (CreateLocationResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/pos/locations', + 'operation_id': 'locations_add', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'location', + 'raw', + 'consumer_id', + 'app_id', + 'service_id', + ], + 'required': [ + 'location', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'location': + (Location,), + 'raw': + (bool,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + }, + 'attribute_map': { + 'raw': 'raw', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + }, + 'location_map': { + 'location': 'body', + 'raw': 'query', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.locations_all_endpoint = _Endpoint( + settings={ + 'response_type': (GetLocationsResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/pos/locations', + 'operation_id': 'locations_all', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'raw', + 'consumer_id', + 'app_id', + 'service_id', + 'cursor', + 'limit', + ], + 'required': [], + 'nullable': [ + 'cursor', + ], + 'enum': [ + ], + 'validation': [ + 'limit', + ] + }, + root_map={ + 'validations': { + ('limit',): { + + 'inclusive_maximum': 200, + 'inclusive_minimum': 1, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'raw': + (bool,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'cursor': + (str, none_type,), + 'limit': + (int,), + }, + 'attribute_map': { + 'raw': 'raw', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'cursor': 'cursor', + 'limit': 'limit', + }, + 'location_map': { + 'raw': 'query', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'cursor': 'query', + 'limit': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.locations_delete_endpoint = _Endpoint( + settings={ + 'response_type': (DeleteLocationResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/pos/locations/{id}', + 'operation_id': 'locations_delete', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + }, + 'location_map': { + 'id': 'path', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.locations_one_endpoint = _Endpoint( + settings={ + 'response_type': (GetLocationResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/pos/locations/{id}', + 'operation_id': 'locations_one', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + }, + 'location_map': { + 'id': 'path', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.locations_update_endpoint = _Endpoint( + settings={ + 'response_type': (UpdateLocationResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/pos/locations/{id}', + 'operation_id': 'locations_update', + 'http_method': 'PATCH', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'location', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + ], + 'required': [ + 'id', + 'location', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'location': + (Location,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + }, + 'location_map': { + 'id': 'path', + 'location': 'body', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.merchants_add_endpoint = _Endpoint( + settings={ + 'response_type': (CreateMerchantResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/pos/merchants', + 'operation_id': 'merchants_add', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'merchant', + 'raw', + 'consumer_id', + 'app_id', + 'service_id', + ], + 'required': [ + 'merchant', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'merchant': + (Merchant,), + 'raw': + (bool,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + }, + 'attribute_map': { + 'raw': 'raw', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + }, + 'location_map': { + 'merchant': 'body', + 'raw': 'query', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.merchants_all_endpoint = _Endpoint( + settings={ + 'response_type': (GetMerchantsResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/pos/merchants', + 'operation_id': 'merchants_all', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'raw', + 'consumer_id', + 'app_id', + 'service_id', + 'cursor', + 'limit', + ], + 'required': [], + 'nullable': [ + 'cursor', + ], + 'enum': [ + ], + 'validation': [ + 'limit', + ] + }, + root_map={ + 'validations': { + ('limit',): { + + 'inclusive_maximum': 200, + 'inclusive_minimum': 1, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'raw': + (bool,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'cursor': + (str, none_type,), + 'limit': + (int,), + }, + 'attribute_map': { + 'raw': 'raw', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'cursor': 'cursor', + 'limit': 'limit', + }, + 'location_map': { + 'raw': 'query', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'cursor': 'query', + 'limit': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.merchants_delete_endpoint = _Endpoint( + settings={ + 'response_type': (DeleteMerchantResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/pos/merchants/{id}', + 'operation_id': 'merchants_delete', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + }, + 'location_map': { + 'id': 'path', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.merchants_one_endpoint = _Endpoint( + settings={ + 'response_type': (GetMerchantResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/pos/merchants/{id}', + 'operation_id': 'merchants_one', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + }, + 'location_map': { + 'id': 'path', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.merchants_update_endpoint = _Endpoint( + settings={ + 'response_type': (UpdateMerchantResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/pos/merchants/{id}', + 'operation_id': 'merchants_update', + 'http_method': 'PATCH', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'merchant', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + ], + 'required': [ + 'id', + 'merchant', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'merchant': + (Merchant,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + }, + 'location_map': { + 'id': 'path', + 'merchant': 'body', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.modifier_groups_add_endpoint = _Endpoint( + settings={ + 'response_type': (CreateModifierGroupResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/pos/modifier-groups', + 'operation_id': 'modifier_groups_add', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'modifier_group', + 'raw', + 'consumer_id', + 'app_id', + 'service_id', + ], + 'required': [ + 'modifier_group', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'modifier_group': + (ModifierGroup,), + 'raw': + (bool,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + }, + 'attribute_map': { + 'raw': 'raw', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + }, + 'location_map': { + 'modifier_group': 'body', + 'raw': 'query', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.modifier_groups_all_endpoint = _Endpoint( + settings={ + 'response_type': (GetModifierGroupsResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/pos/modifier-groups', + 'operation_id': 'modifier_groups_all', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'raw', + 'consumer_id', + 'app_id', + 'service_id', + 'cursor', + 'limit', + ], + 'required': [], + 'nullable': [ + 'cursor', + ], + 'enum': [ + ], + 'validation': [ + 'limit', + ] + }, + root_map={ + 'validations': { + ('limit',): { + + 'inclusive_maximum': 200, + 'inclusive_minimum': 1, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'raw': + (bool,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'cursor': + (str, none_type,), + 'limit': + (int,), + }, + 'attribute_map': { + 'raw': 'raw', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'cursor': 'cursor', + 'limit': 'limit', + }, + 'location_map': { + 'raw': 'query', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'cursor': 'query', + 'limit': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.modifier_groups_delete_endpoint = _Endpoint( + settings={ + 'response_type': (DeleteModifierGroupResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/pos/modifier-groups/{id}', + 'operation_id': 'modifier_groups_delete', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + }, + 'location_map': { + 'id': 'path', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.modifier_groups_one_endpoint = _Endpoint( + settings={ + 'response_type': (GetModifierGroupResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/pos/modifier-groups/{id}', + 'operation_id': 'modifier_groups_one', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + }, + 'location_map': { + 'id': 'path', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.modifier_groups_update_endpoint = _Endpoint( + settings={ + 'response_type': (UpdateModifierGroupResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/pos/modifier-groups/{id}', + 'operation_id': 'modifier_groups_update', + 'http_method': 'PATCH', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'modifier_group', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + ], + 'required': [ + 'id', + 'modifier_group', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'modifier_group': + (ModifierGroup,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + }, + 'location_map': { + 'id': 'path', + 'modifier_group': 'body', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.modifiers_add_endpoint = _Endpoint( + settings={ + 'response_type': (CreateModifierResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/pos/modifiers', + 'operation_id': 'modifiers_add', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'modifier', + 'raw', + 'consumer_id', + 'app_id', + 'service_id', + ], + 'required': [ + 'modifier', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'modifier': + (Modifier,), + 'raw': + (bool,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + }, + 'attribute_map': { + 'raw': 'raw', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + }, + 'location_map': { + 'modifier': 'body', + 'raw': 'query', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.modifiers_all_endpoint = _Endpoint( + settings={ + 'response_type': (GetModifiersResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/pos/modifiers', + 'operation_id': 'modifiers_all', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'raw', + 'consumer_id', + 'app_id', + 'service_id', + 'cursor', + 'limit', + ], + 'required': [], + 'nullable': [ + 'cursor', + ], + 'enum': [ + ], + 'validation': [ + 'limit', + ] + }, + root_map={ + 'validations': { + ('limit',): { + + 'inclusive_maximum': 200, + 'inclusive_minimum': 1, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'raw': + (bool,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'cursor': + (str, none_type,), + 'limit': + (int,), + }, + 'attribute_map': { + 'raw': 'raw', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'cursor': 'cursor', + 'limit': 'limit', + }, + 'location_map': { + 'raw': 'query', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'cursor': 'query', + 'limit': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.modifiers_delete_endpoint = _Endpoint( + settings={ + 'response_type': (DeleteModifierResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/pos/modifiers/{id}', + 'operation_id': 'modifiers_delete', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + 'filter', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + 'filter': + (ModifierGroupFilter,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + 'filter': 'filter', + }, + 'location_map': { + 'id': 'path', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + 'filter': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.modifiers_one_endpoint = _Endpoint( + settings={ + 'response_type': (GetModifierResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/pos/modifiers/{id}', + 'operation_id': 'modifiers_one', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + 'filter', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + 'filter': + (ModifierGroupFilter,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + 'filter': 'filter', + }, + 'location_map': { + 'id': 'path', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + 'filter': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.modifiers_update_endpoint = _Endpoint( + settings={ + 'response_type': (UpdateModifierResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/pos/modifiers/{id}', + 'operation_id': 'modifiers_update', + 'http_method': 'PATCH', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'modifier', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + ], + 'required': [ + 'id', + 'modifier', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'modifier': + (Modifier,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + }, + 'location_map': { + 'id': 'path', + 'modifier': 'body', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.order_types_add_endpoint = _Endpoint( + settings={ + 'response_type': (CreateOrderTypeResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/pos/order-types', + 'operation_id': 'order_types_add', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'order_type', + 'raw', + 'consumer_id', + 'app_id', + 'service_id', + ], + 'required': [ + 'order_type', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'order_type': + (OrderType,), + 'raw': + (bool,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + }, + 'attribute_map': { + 'raw': 'raw', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + }, + 'location_map': { + 'order_type': 'body', + 'raw': 'query', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.order_types_all_endpoint = _Endpoint( + settings={ + 'response_type': (GetOrderTypesResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/pos/order-types', + 'operation_id': 'order_types_all', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'raw', + 'consumer_id', + 'app_id', + 'service_id', + 'cursor', + 'limit', + ], + 'required': [], + 'nullable': [ + 'cursor', + ], + 'enum': [ + ], + 'validation': [ + 'limit', + ] + }, + root_map={ + 'validations': { + ('limit',): { + + 'inclusive_maximum': 200, + 'inclusive_minimum': 1, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'raw': + (bool,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'cursor': + (str, none_type,), + 'limit': + (int,), + }, + 'attribute_map': { + 'raw': 'raw', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'cursor': 'cursor', + 'limit': 'limit', + }, + 'location_map': { + 'raw': 'query', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'cursor': 'query', + 'limit': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.order_types_delete_endpoint = _Endpoint( + settings={ + 'response_type': (DeleteOrderTypeResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/pos/order-types/{id}', + 'operation_id': 'order_types_delete', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + }, + 'location_map': { + 'id': 'path', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.order_types_one_endpoint = _Endpoint( + settings={ + 'response_type': (GetOrderTypeResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/pos/order-types/{id}', + 'operation_id': 'order_types_one', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + }, + 'location_map': { + 'id': 'path', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.order_types_update_endpoint = _Endpoint( + settings={ + 'response_type': (UpdateOrderTypeResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/pos/order-types/{id}', + 'operation_id': 'order_types_update', + 'http_method': 'PATCH', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'order_type', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + ], + 'required': [ + 'id', + 'order_type', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'order_type': + (OrderType,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + }, + 'location_map': { + 'id': 'path', + 'order_type': 'body', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.orders_add_endpoint = _Endpoint( + settings={ + 'response_type': (CreateOrderResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/pos/orders', + 'operation_id': 'orders_add', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'order', + 'raw', + 'consumer_id', + 'app_id', + 'service_id', + ], + 'required': [ + 'order', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'order': + (Order,), + 'raw': + (bool,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + }, + 'attribute_map': { + 'raw': 'raw', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + }, + 'location_map': { + 'order': 'body', + 'raw': 'query', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.orders_all_endpoint = _Endpoint( + settings={ + 'response_type': (GetOrdersResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/pos/orders', + 'operation_id': 'orders_all', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'raw', + 'consumer_id', + 'app_id', + 'service_id', + 'cursor', + 'limit', + 'location_id', + ], + 'required': [], + 'nullable': [ + 'cursor', + ], + 'enum': [ + ], + 'validation': [ + 'limit', + ] + }, + root_map={ + 'validations': { + ('limit',): { + + 'inclusive_maximum': 200, + 'inclusive_minimum': 1, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'raw': + (bool,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'cursor': + (str, none_type,), + 'limit': + (int,), + 'location_id': + (str,), + }, + 'attribute_map': { + 'raw': 'raw', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'cursor': 'cursor', + 'limit': 'limit', + 'location_id': 'location_id', + }, + 'location_map': { + 'raw': 'query', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'cursor': 'query', + 'limit': 'query', + 'location_id': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.orders_delete_endpoint = _Endpoint( + settings={ + 'response_type': (DeleteOrderResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/pos/orders/{id}', + 'operation_id': 'orders_delete', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + }, + 'location_map': { + 'id': 'path', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.orders_one_endpoint = _Endpoint( + settings={ + 'response_type': (GetOrderResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/pos/orders/{id}', + 'operation_id': 'orders_one', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + }, + 'location_map': { + 'id': 'path', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.orders_pay_endpoint = _Endpoint( + settings={ + 'response_type': (CreateOrderResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/pos/orders/{id}/pay', + 'operation_id': 'orders_pay', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'order', + 'raw', + 'consumer_id', + 'app_id', + 'service_id', + ], + 'required': [ + 'id', + 'order', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'order': + (Order,), + 'raw': + (bool,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + 'raw': 'raw', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + }, + 'location_map': { + 'id': 'path', + 'order': 'body', + 'raw': 'query', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.orders_update_endpoint = _Endpoint( + settings={ + 'response_type': (UpdateOrderResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/pos/orders/{id}', + 'operation_id': 'orders_update', + 'http_method': 'PATCH', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'order', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + ], + 'required': [ + 'id', + 'order', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'order': + (Order,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + }, + 'location_map': { + 'id': 'path', + 'order': 'body', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.payments_add_endpoint = _Endpoint( + settings={ + 'response_type': (CreatePosPaymentResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/pos/payments', + 'operation_id': 'payments_add', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'pos_payment', + 'raw', + 'consumer_id', + 'app_id', + 'service_id', + ], + 'required': [ + 'pos_payment', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'pos_payment': + (PosPayment,), + 'raw': + (bool,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + }, + 'attribute_map': { + 'raw': 'raw', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + }, + 'location_map': { + 'pos_payment': 'body', + 'raw': 'query', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.payments_all_endpoint = _Endpoint( + settings={ + 'response_type': (GetPosPaymentsResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/pos/payments', + 'operation_id': 'payments_all', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'raw', + 'consumer_id', + 'app_id', + 'service_id', + 'cursor', + 'limit', + ], + 'required': [], + 'nullable': [ + 'cursor', + ], + 'enum': [ + ], + 'validation': [ + 'limit', + ] + }, + root_map={ + 'validations': { + ('limit',): { + + 'inclusive_maximum': 200, + 'inclusive_minimum': 1, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'raw': + (bool,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'cursor': + (str, none_type,), + 'limit': + (int,), + }, + 'attribute_map': { + 'raw': 'raw', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'cursor': 'cursor', + 'limit': 'limit', + }, + 'location_map': { + 'raw': 'query', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'cursor': 'query', + 'limit': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.payments_delete_endpoint = _Endpoint( + settings={ + 'response_type': (DeletePosPaymentResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/pos/payments/{id}', + 'operation_id': 'payments_delete', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + }, + 'location_map': { + 'id': 'path', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.payments_one_endpoint = _Endpoint( + settings={ + 'response_type': (GetPosPaymentResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/pos/payments/{id}', + 'operation_id': 'payments_one', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + }, + 'location_map': { + 'id': 'path', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.payments_update_endpoint = _Endpoint( + settings={ + 'response_type': (UpdatePosPaymentResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/pos/payments/{id}', + 'operation_id': 'payments_update', + 'http_method': 'PATCH', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'pos_payment', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + ], + 'required': [ + 'id', + 'pos_payment', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'pos_payment': + (PosPayment,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + }, + 'location_map': { + 'id': 'path', + 'pos_payment': 'body', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.tenders_add_endpoint = _Endpoint( + settings={ + 'response_type': (CreateTenderResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/pos/tenders', + 'operation_id': 'tenders_add', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'tender', + 'raw', + 'consumer_id', + 'app_id', + 'service_id', + ], + 'required': [ + 'tender', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'tender': + (Tender,), + 'raw': + (bool,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + }, + 'attribute_map': { + 'raw': 'raw', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + }, + 'location_map': { + 'tender': 'body', + 'raw': 'query', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.tenders_all_endpoint = _Endpoint( + settings={ + 'response_type': (GetTendersResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/pos/tenders', + 'operation_id': 'tenders_all', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'raw', + 'consumer_id', + 'app_id', + 'service_id', + 'cursor', + 'limit', + ], + 'required': [], + 'nullable': [ + 'cursor', + ], + 'enum': [ + ], + 'validation': [ + 'limit', + ] + }, + root_map={ + 'validations': { + ('limit',): { + + 'inclusive_maximum': 200, + 'inclusive_minimum': 1, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'raw': + (bool,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'cursor': + (str, none_type,), + 'limit': + (int,), + }, + 'attribute_map': { + 'raw': 'raw', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'cursor': 'cursor', + 'limit': 'limit', + }, + 'location_map': { + 'raw': 'query', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'cursor': 'query', + 'limit': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.tenders_delete_endpoint = _Endpoint( + settings={ + 'response_type': (DeleteTenderResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/pos/tenders/{id}', + 'operation_id': 'tenders_delete', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + }, + 'location_map': { + 'id': 'path', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.tenders_one_endpoint = _Endpoint( + settings={ + 'response_type': (GetTenderResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/pos/tenders/{id}', + 'operation_id': 'tenders_one', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + }, + 'location_map': { + 'id': 'path', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.tenders_update_endpoint = _Endpoint( + settings={ + 'response_type': (UpdateTenderResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/pos/tenders/{id}', + 'operation_id': 'tenders_update', + 'http_method': 'PATCH', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'tender', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + ], + 'required': [ + 'id', + 'tender', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'tender': + (Tender,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + }, + 'location_map': { + 'id': 'path', + 'tender': 'body', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + + def items_add( + self, + item, + **kwargs + ): + """Create Item # noqa: E501 + + Create Item # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.items_add(item, async_req=True) + >>> result = thread.get() + + Args: + item (Item): + + Keyword Args: + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + CreateItemResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['item'] = \ + item + return self.items_add_endpoint.call_with_http_info(**kwargs) + + def items_all( + self, + **kwargs + ): + """List Items # noqa: E501 + + List Items # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.items_all(async_req=True) + >>> result = thread.get() + + + Keyword Args: + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + cursor (str, none_type): Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.. [optional] + limit (int): Number of records to return. [optional] if omitted the server will use the default value of 20 + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + GetItemsResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + return self.items_all_endpoint.call_with_http_info(**kwargs) + + def items_delete( + self, + id, + **kwargs + ): + """Delete Item # noqa: E501 + + Delete Item # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.items_delete(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + DeleteItemResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + return self.items_delete_endpoint.call_with_http_info(**kwargs) + + def items_one( + self, + id, + **kwargs + ): + """Get Item # noqa: E501 + + Get Item # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.items_one(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + GetItemResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + return self.items_one_endpoint.call_with_http_info(**kwargs) + + def items_update( + self, + id, + item, + **kwargs + ): + """Update Item # noqa: E501 + + Update Item # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.items_update(id, item, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + item (Item): + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + UpdateItemResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + kwargs['item'] = \ + item + return self.items_update_endpoint.call_with_http_info(**kwargs) + + def locations_add( + self, + location, + **kwargs + ): + """Create Location # noqa: E501 + + Create Location # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.locations_add(location, async_req=True) + >>> result = thread.get() + + Args: + location (Location): + + Keyword Args: + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + CreateLocationResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['location'] = \ + location + return self.locations_add_endpoint.call_with_http_info(**kwargs) + + def locations_all( + self, + **kwargs + ): + """List Locations # noqa: E501 + + List Locations # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.locations_all(async_req=True) + >>> result = thread.get() + + + Keyword Args: + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + cursor (str, none_type): Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.. [optional] + limit (int): Number of records to return. [optional] if omitted the server will use the default value of 20 + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + GetLocationsResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + return self.locations_all_endpoint.call_with_http_info(**kwargs) + + def locations_delete( + self, + id, + **kwargs + ): + """Delete Location # noqa: E501 + + Delete Location # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.locations_delete(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + DeleteLocationResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + return self.locations_delete_endpoint.call_with_http_info(**kwargs) + + def locations_one( + self, + id, + **kwargs + ): + """Get Location # noqa: E501 + + Get Location # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.locations_one(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + GetLocationResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + return self.locations_one_endpoint.call_with_http_info(**kwargs) + + def locations_update( + self, + id, + location, + **kwargs + ): + """Update Location # noqa: E501 + + Update Location # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.locations_update(id, location, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + location (Location): + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + UpdateLocationResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + kwargs['location'] = \ + location + return self.locations_update_endpoint.call_with_http_info(**kwargs) + + def merchants_add( + self, + merchant, + **kwargs + ): + """Create Merchant # noqa: E501 + + Create Merchant # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.merchants_add(merchant, async_req=True) + >>> result = thread.get() + + Args: + merchant (Merchant): + + Keyword Args: + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + CreateMerchantResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['merchant'] = \ + merchant + return self.merchants_add_endpoint.call_with_http_info(**kwargs) + + def merchants_all( + self, + **kwargs + ): + """List Merchants # noqa: E501 + + List Merchants # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.merchants_all(async_req=True) + >>> result = thread.get() + + + Keyword Args: + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + cursor (str, none_type): Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.. [optional] + limit (int): Number of records to return. [optional] if omitted the server will use the default value of 20 + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + GetMerchantsResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + return self.merchants_all_endpoint.call_with_http_info(**kwargs) + + def merchants_delete( + self, + id, + **kwargs + ): + """Delete Merchant # noqa: E501 + + Delete Merchant # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.merchants_delete(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + DeleteMerchantResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + return self.merchants_delete_endpoint.call_with_http_info(**kwargs) + + def merchants_one( + self, + id, + **kwargs + ): + """Get Merchant # noqa: E501 + + Get Merchant # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.merchants_one(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + GetMerchantResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + return self.merchants_one_endpoint.call_with_http_info(**kwargs) + + def merchants_update( + self, + id, + merchant, + **kwargs + ): + """Update Merchant # noqa: E501 + + Update Merchant # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.merchants_update(id, merchant, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + merchant (Merchant): + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + UpdateMerchantResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + kwargs['merchant'] = \ + merchant + return self.merchants_update_endpoint.call_with_http_info(**kwargs) + + def modifier_groups_add( + self, + modifier_group, + **kwargs + ): + """Create Modifier Group # noqa: E501 + + Create Modifier Group # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.modifier_groups_add(modifier_group, async_req=True) + >>> result = thread.get() + + Args: + modifier_group (ModifierGroup): + + Keyword Args: + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + CreateModifierGroupResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['modifier_group'] = \ + modifier_group + return self.modifier_groups_add_endpoint.call_with_http_info(**kwargs) + + def modifier_groups_all( + self, + **kwargs + ): + """List Modifier Groups # noqa: E501 + + List Modifier Groups # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.modifier_groups_all(async_req=True) + >>> result = thread.get() + + + Keyword Args: + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + cursor (str, none_type): Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.. [optional] + limit (int): Number of records to return. [optional] if omitted the server will use the default value of 20 + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + GetModifierGroupsResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + return self.modifier_groups_all_endpoint.call_with_http_info(**kwargs) + + def modifier_groups_delete( + self, + id, + **kwargs + ): + """Delete Modifier Group # noqa: E501 + + Delete Modifier Group # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.modifier_groups_delete(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + DeleteModifierGroupResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + return self.modifier_groups_delete_endpoint.call_with_http_info(**kwargs) + + def modifier_groups_one( + self, + id, + **kwargs + ): + """Get Modifier Group # noqa: E501 + + Get Modifier Group # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.modifier_groups_one(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + GetModifierGroupResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + return self.modifier_groups_one_endpoint.call_with_http_info(**kwargs) + + def modifier_groups_update( + self, + id, + modifier_group, + **kwargs + ): + """Update Modifier Group # noqa: E501 + + Update Modifier Group # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.modifier_groups_update(id, modifier_group, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + modifier_group (ModifierGroup): + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + UpdateModifierGroupResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + kwargs['modifier_group'] = \ + modifier_group + return self.modifier_groups_update_endpoint.call_with_http_info(**kwargs) + + def modifiers_add( + self, + modifier, + **kwargs + ): + """Create Modifier # noqa: E501 + + Create Modifier # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.modifiers_add(modifier, async_req=True) + >>> result = thread.get() + + Args: + modifier (Modifier): + + Keyword Args: + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + CreateModifierResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['modifier'] = \ + modifier + return self.modifiers_add_endpoint.call_with_http_info(**kwargs) + + def modifiers_all( + self, + **kwargs + ): + """List Modifiers # noqa: E501 + + List Modifiers # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.modifiers_all(async_req=True) + >>> result = thread.get() + + + Keyword Args: + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + cursor (str, none_type): Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.. [optional] + limit (int): Number of records to return. [optional] if omitted the server will use the default value of 20 + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + GetModifiersResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + return self.modifiers_all_endpoint.call_with_http_info(**kwargs) + + def modifiers_delete( + self, + id, + **kwargs + ): + """Delete Modifier # noqa: E501 + + Delete Modifier # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.modifiers_delete(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + filter (ModifierGroupFilter): Apply filters. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + DeleteModifierResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + return self.modifiers_delete_endpoint.call_with_http_info(**kwargs) + + def modifiers_one( + self, + id, + **kwargs + ): + """Get Modifier # noqa: E501 + + Get Modifier # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.modifiers_one(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + filter (ModifierGroupFilter): Apply filters. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + GetModifierResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + return self.modifiers_one_endpoint.call_with_http_info(**kwargs) + + def modifiers_update( + self, + id, + modifier, + **kwargs + ): + """Update Modifier # noqa: E501 + + Update Modifier # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.modifiers_update(id, modifier, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + modifier (Modifier): + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + UpdateModifierResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + kwargs['modifier'] = \ + modifier + return self.modifiers_update_endpoint.call_with_http_info(**kwargs) + + def order_types_add( + self, + order_type, + **kwargs + ): + """Create Order Type # noqa: E501 + + Create Order Type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.order_types_add(order_type, async_req=True) + >>> result = thread.get() + + Args: + order_type (OrderType): + + Keyword Args: + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + CreateOrderTypeResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['order_type'] = \ + order_type + return self.order_types_add_endpoint.call_with_http_info(**kwargs) + + def order_types_all( + self, + **kwargs + ): + """List Order Types # noqa: E501 + + List Order Types # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.order_types_all(async_req=True) + >>> result = thread.get() + + + Keyword Args: + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + cursor (str, none_type): Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.. [optional] + limit (int): Number of records to return. [optional] if omitted the server will use the default value of 20 + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + GetOrderTypesResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + return self.order_types_all_endpoint.call_with_http_info(**kwargs) + + def order_types_delete( + self, + id, + **kwargs + ): + """Delete Order Type # noqa: E501 + + Delete Order Type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.order_types_delete(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + DeleteOrderTypeResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + return self.order_types_delete_endpoint.call_with_http_info(**kwargs) + + def order_types_one( + self, + id, + **kwargs + ): + """Get Order Type # noqa: E501 + + Get Order Type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.order_types_one(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + GetOrderTypeResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + return self.order_types_one_endpoint.call_with_http_info(**kwargs) + + def order_types_update( + self, + id, + order_type, + **kwargs + ): + """Update Order Type # noqa: E501 + + Update Order Type # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.order_types_update(id, order_type, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + order_type (OrderType): + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + UpdateOrderTypeResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + kwargs['order_type'] = \ + order_type + return self.order_types_update_endpoint.call_with_http_info(**kwargs) + + def orders_add( + self, + order, + **kwargs + ): + """Create Order # noqa: E501 + + Create Order # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.orders_add(order, async_req=True) + >>> result = thread.get() + + Args: + order (Order): + + Keyword Args: + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + CreateOrderResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['order'] = \ + order + return self.orders_add_endpoint.call_with_http_info(**kwargs) + + def orders_all( + self, + **kwargs + ): + """List Orders # noqa: E501 + + List Orders # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.orders_all(async_req=True) + >>> result = thread.get() + + + Keyword Args: + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + cursor (str, none_type): Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.. [optional] + limit (int): Number of records to return. [optional] if omitted the server will use the default value of 20 + location_id (str): ID of the location.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + GetOrdersResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + return self.orders_all_endpoint.call_with_http_info(**kwargs) + + def orders_delete( + self, + id, + **kwargs + ): + """Delete Order # noqa: E501 + + Delete Order # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.orders_delete(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + DeleteOrderResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + return self.orders_delete_endpoint.call_with_http_info(**kwargs) + + def orders_one( + self, + id, + **kwargs + ): + """Get Order # noqa: E501 + + Get Order # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.orders_one(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + GetOrderResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + return self.orders_one_endpoint.call_with_http_info(**kwargs) + + def orders_pay( + self, + id, + order, + **kwargs + ): + """Pay Order # noqa: E501 + + Pay Order # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.orders_pay(id, order, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + order (Order): + + Keyword Args: + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + CreateOrderResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + kwargs['order'] = \ + order + return self.orders_pay_endpoint.call_with_http_info(**kwargs) + + def orders_update( + self, + id, + order, + **kwargs + ): + """Update Order # noqa: E501 + + Updates an open order by adding, replacing, or deleting fields. Square-only: Orders with a `completed` or `canceled` status cannot be updated. To pay for an order, use the [payments endpoint](#tag/Payments). # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.orders_update(id, order, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + order (Order): + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + UpdateOrderResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + kwargs['order'] = \ + order + return self.orders_update_endpoint.call_with_http_info(**kwargs) + + def payments_add( + self, + pos_payment, + **kwargs + ): + """Create Payment # noqa: E501 + + Create Payment # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.payments_add(pos_payment, async_req=True) + >>> result = thread.get() + + Args: + pos_payment (PosPayment): + + Keyword Args: + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + CreatePosPaymentResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['pos_payment'] = \ + pos_payment + return self.payments_add_endpoint.call_with_http_info(**kwargs) + + def payments_all( + self, + **kwargs + ): + """List Payments # noqa: E501 + + List Payments # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.payments_all(async_req=True) + >>> result = thread.get() + + + Keyword Args: + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + cursor (str, none_type): Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.. [optional] + limit (int): Number of records to return. [optional] if omitted the server will use the default value of 20 + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + GetPosPaymentsResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + return self.payments_all_endpoint.call_with_http_info(**kwargs) + + def payments_delete( + self, + id, + **kwargs + ): + """Delete Payment # noqa: E501 + + Delete Payment # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.payments_delete(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + DeletePosPaymentResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + return self.payments_delete_endpoint.call_with_http_info(**kwargs) + + def payments_one( + self, + id, + **kwargs + ): + """Get Payment # noqa: E501 + + Get Payment # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.payments_one(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + GetPosPaymentResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + return self.payments_one_endpoint.call_with_http_info(**kwargs) + + def payments_update( + self, + id, + pos_payment, + **kwargs + ): + """Update Payment # noqa: E501 + + Update Payment # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.payments_update(id, pos_payment, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + pos_payment (PosPayment): + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + UpdatePosPaymentResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + kwargs['pos_payment'] = \ + pos_payment + return self.payments_update_endpoint.call_with_http_info(**kwargs) + + def tenders_add( + self, + tender, + **kwargs + ): + """Create Tender # noqa: E501 + + Create Tender # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.tenders_add(tender, async_req=True) + >>> result = thread.get() + + Args: + tender (Tender): + + Keyword Args: + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + CreateTenderResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['tender'] = \ + tender + return self.tenders_add_endpoint.call_with_http_info(**kwargs) + + def tenders_all( + self, + **kwargs + ): + """List Tenders # noqa: E501 + + List Tenders # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.tenders_all(async_req=True) + >>> result = thread.get() + + + Keyword Args: + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + cursor (str, none_type): Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.. [optional] + limit (int): Number of records to return. [optional] if omitted the server will use the default value of 20 + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + GetTendersResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + return self.tenders_all_endpoint.call_with_http_info(**kwargs) + + def tenders_delete( + self, + id, + **kwargs + ): + """Delete Tender # noqa: E501 + + Delete Tender # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.tenders_delete(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + DeleteTenderResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + return self.tenders_delete_endpoint.call_with_http_info(**kwargs) + + def tenders_one( + self, + id, + **kwargs + ): + """Get Tender # noqa: E501 + + Get Tender # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.tenders_one(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + GetTenderResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + return self.tenders_one_endpoint.call_with_http_info(**kwargs) + + def tenders_update( + self, + id, + tender, + **kwargs + ): + """Update Tender # noqa: E501 + + Update Tender # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.tenders_update(id, tender, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + tender (Tender): + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + UpdateTenderResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + kwargs['tender'] = \ + tender + return self.tenders_update_endpoint.call_with_http_info(**kwargs) + diff --git a/src/apideck/api/sms_api.py b/src/apideck/api/sms_api.py new file mode 100644 index 0000000000..9d68468105 --- /dev/null +++ b/src/apideck/api/sms_api.py @@ -0,0 +1,833 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.api_client import ApiClient, Endpoint as _Endpoint +from apideck.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.create_message_response import CreateMessageResponse +from apideck.model.delete_message_response import DeleteMessageResponse +from apideck.model.get_message_response import GetMessageResponse +from apideck.model.get_messages_response import GetMessagesResponse +from apideck.model.message import Message +from apideck.model.not_found_response import NotFoundResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.update_message_response import UpdateMessageResponse + + +class SmsApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.messages_add_endpoint = _Endpoint( + settings={ + 'response_type': (CreateMessageResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/sms/messages', + 'operation_id': 'messages_add', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'message', + 'raw', + 'consumer_id', + 'app_id', + 'service_id', + ], + 'required': [ + 'message', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'message': + (Message,), + 'raw': + (bool,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + }, + 'attribute_map': { + 'raw': 'raw', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + }, + 'location_map': { + 'message': 'body', + 'raw': 'query', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.messages_all_endpoint = _Endpoint( + settings={ + 'response_type': (GetMessagesResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/sms/messages', + 'operation_id': 'messages_all', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'raw', + 'consumer_id', + 'app_id', + 'service_id', + 'cursor', + 'limit', + ], + 'required': [], + 'nullable': [ + 'cursor', + ], + 'enum': [ + ], + 'validation': [ + 'limit', + ] + }, + root_map={ + 'validations': { + ('limit',): { + + 'inclusive_maximum': 200, + 'inclusive_minimum': 1, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'raw': + (bool,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'cursor': + (str, none_type,), + 'limit': + (int,), + }, + 'attribute_map': { + 'raw': 'raw', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'cursor': 'cursor', + 'limit': 'limit', + }, + 'location_map': { + 'raw': 'query', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'cursor': 'query', + 'limit': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.messages_delete_endpoint = _Endpoint( + settings={ + 'response_type': (DeleteMessageResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/sms/messages/{id}', + 'operation_id': 'messages_delete', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + }, + 'location_map': { + 'id': 'path', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.messages_one_endpoint = _Endpoint( + settings={ + 'response_type': (GetMessageResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/sms/messages/{id}', + 'operation_id': 'messages_one', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + }, + 'location_map': { + 'id': 'path', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.messages_update_endpoint = _Endpoint( + settings={ + 'response_type': (UpdateMessageResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/sms/messages/{id}', + 'operation_id': 'messages_update', + 'http_method': 'PATCH', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'message', + 'consumer_id', + 'app_id', + 'service_id', + 'raw', + ], + 'required': [ + 'id', + 'message', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'message': + (Message,), + 'consumer_id': + (str,), + 'app_id': + (str,), + 'service_id': + (str,), + 'raw': + (bool,), + }, + 'attribute_map': { + 'id': 'id', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'service_id': 'x-apideck-service-id', + 'raw': 'raw', + }, + 'location_map': { + 'id': 'path', + 'message': 'body', + 'consumer_id': 'header', + 'app_id': 'header', + 'service_id': 'header', + 'raw': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + + def messages_add( + self, + message, + **kwargs + ): + """Create Message # noqa: E501 + + Create Message # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.messages_add(message, async_req=True) + >>> result = thread.get() + + Args: + message (Message): + + Keyword Args: + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + CreateMessageResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['message'] = \ + message + return self.messages_add_endpoint.call_with_http_info(**kwargs) + + def messages_all( + self, + **kwargs + ): + """List Messages # noqa: E501 + + List Messages # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.messages_all(async_req=True) + >>> result = thread.get() + + + Keyword Args: + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + cursor (str, none_type): Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.. [optional] + limit (int): Number of records to return. [optional] if omitted the server will use the default value of 20 + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + GetMessagesResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + return self.messages_all_endpoint.call_with_http_info(**kwargs) + + def messages_delete( + self, + id, + **kwargs + ): + """Delete Message # noqa: E501 + + Delete Message # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.messages_delete(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + DeleteMessageResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + return self.messages_delete_endpoint.call_with_http_info(**kwargs) + + def messages_one( + self, + id, + **kwargs + ): + """Get Message # noqa: E501 + + Get Message # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.messages_one(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + GetMessageResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + return self.messages_one_endpoint.call_with_http_info(**kwargs) + + def messages_update( + self, + id, + message, + **kwargs + ): + """Update Message # noqa: E501 + + Update Message # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.messages_update(id, message, async_req=True) + >>> result = thread.get() + + Args: + id (str): ID of the record you are acting upon. + message (Message): + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + service_id (str): Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.. [optional] + raw (bool): Include raw response. Mostly used for debugging purposes. [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + UpdateMessageResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + kwargs['message'] = \ + message + return self.messages_update_endpoint.call_with_http_info(**kwargs) + diff --git a/src/apideck/api/vault_api.py b/src/apideck/api/vault_api.py new file mode 100644 index 0000000000..0fc3271d73 --- /dev/null +++ b/src/apideck/api/vault_api.py @@ -0,0 +1,1878 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.api_client import ApiClient, Endpoint as _Endpoint +from apideck.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.connection import Connection +from apideck.model.connection_import_data import ConnectionImportData +from apideck.model.consumer_request_counts_in_date_range_response import ConsumerRequestCountsInDateRangeResponse +from apideck.model.create_connection_response import CreateConnectionResponse +from apideck.model.create_session_response import CreateSessionResponse +from apideck.model.get_connection_response import GetConnectionResponse +from apideck.model.get_connections_response import GetConnectionsResponse +from apideck.model.get_consumer_response import GetConsumerResponse +from apideck.model.get_consumers_response import GetConsumersResponse +from apideck.model.get_logs_response import GetLogsResponse +from apideck.model.logs_filter import LogsFilter +from apideck.model.not_found_response import NotFoundResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.session import Session +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.update_connection_response import UpdateConnectionResponse + + +class VaultApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.connection_settings_all_endpoint = _Endpoint( + settings={ + 'response_type': (GetConnectionResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/vault/connections/{unified_api}/{service_id}/{resource}/config', + 'operation_id': 'connection_settings_all', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'unified_api', + 'service_id', + 'resource', + 'consumer_id', + 'app_id', + ], + 'required': [ + 'unified_api', + 'service_id', + 'resource', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'unified_api': + (str,), + 'service_id': + (str,), + 'resource': + (str,), + 'consumer_id': + (str,), + 'app_id': + (str,), + }, + 'attribute_map': { + 'unified_api': 'unified_api', + 'service_id': 'service_id', + 'resource': 'resource', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + }, + 'location_map': { + 'unified_api': 'path', + 'service_id': 'path', + 'resource': 'path', + 'consumer_id': 'header', + 'app_id': 'header', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.connection_settings_update_endpoint = _Endpoint( + settings={ + 'response_type': (UpdateConnectionResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/vault/connections/{unified_api}/{service_id}/{resource}/config', + 'operation_id': 'connection_settings_update', + 'http_method': 'PATCH', + 'servers': None, + }, + params_map={ + 'all': [ + 'service_id', + 'unified_api', + 'resource', + 'connection', + 'consumer_id', + 'app_id', + ], + 'required': [ + 'service_id', + 'unified_api', + 'resource', + 'connection', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'service_id': + (str,), + 'unified_api': + (str,), + 'resource': + (str,), + 'connection': + (Connection,), + 'consumer_id': + (str,), + 'app_id': + (str,), + }, + 'attribute_map': { + 'service_id': 'service_id', + 'unified_api': 'unified_api', + 'resource': 'resource', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + }, + 'location_map': { + 'service_id': 'path', + 'unified_api': 'path', + 'resource': 'path', + 'connection': 'body', + 'consumer_id': 'header', + 'app_id': 'header', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.connections_all_endpoint = _Endpoint( + settings={ + 'response_type': (GetConnectionsResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/vault/connections', + 'operation_id': 'connections_all', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'consumer_id', + 'app_id', + 'api', + 'configured', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'consumer_id': + (str,), + 'app_id': + (str,), + 'api': + (str,), + 'configured': + (bool,), + }, + 'attribute_map': { + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + 'api': 'api', + 'configured': 'configured', + }, + 'location_map': { + 'consumer_id': 'header', + 'app_id': 'header', + 'api': 'query', + 'configured': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.connections_delete_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/vault/connections/{unified_api}/{service_id}', + 'operation_id': 'connections_delete', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'service_id', + 'unified_api', + 'consumer_id', + 'app_id', + ], + 'required': [ + 'service_id', + 'unified_api', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'service_id': + (str,), + 'unified_api': + (str,), + 'consumer_id': + (str,), + 'app_id': + (str,), + }, + 'attribute_map': { + 'service_id': 'service_id', + 'unified_api': 'unified_api', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + }, + 'location_map': { + 'service_id': 'path', + 'unified_api': 'path', + 'consumer_id': 'header', + 'app_id': 'header', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.connections_import_endpoint = _Endpoint( + settings={ + 'response_type': (CreateConnectionResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/vault/connections/{unified_api}/{service_id}/import', + 'operation_id': 'connections_import', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'service_id', + 'unified_api', + 'connection_import_data', + 'consumer_id', + 'app_id', + ], + 'required': [ + 'service_id', + 'unified_api', + 'connection_import_data', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'service_id': + (str,), + 'unified_api': + (str,), + 'connection_import_data': + (ConnectionImportData,), + 'consumer_id': + (str,), + 'app_id': + (str,), + }, + 'attribute_map': { + 'service_id': 'service_id', + 'unified_api': 'unified_api', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + }, + 'location_map': { + 'service_id': 'path', + 'unified_api': 'path', + 'connection_import_data': 'body', + 'consumer_id': 'header', + 'app_id': 'header', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.connections_one_endpoint = _Endpoint( + settings={ + 'response_type': (GetConnectionResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/vault/connections/{unified_api}/{service_id}', + 'operation_id': 'connections_one', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'service_id', + 'unified_api', + 'consumer_id', + 'app_id', + ], + 'required': [ + 'service_id', + 'unified_api', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'service_id': + (str,), + 'unified_api': + (str,), + 'consumer_id': + (str,), + 'app_id': + (str,), + }, + 'attribute_map': { + 'service_id': 'service_id', + 'unified_api': 'unified_api', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + }, + 'location_map': { + 'service_id': 'path', + 'unified_api': 'path', + 'consumer_id': 'header', + 'app_id': 'header', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.connections_update_endpoint = _Endpoint( + settings={ + 'response_type': (UpdateConnectionResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/vault/connections/{unified_api}/{service_id}', + 'operation_id': 'connections_update', + 'http_method': 'PATCH', + 'servers': None, + }, + params_map={ + 'all': [ + 'service_id', + 'unified_api', + 'connection', + 'consumer_id', + 'app_id', + ], + 'required': [ + 'service_id', + 'unified_api', + 'connection', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'service_id': + (str,), + 'unified_api': + (str,), + 'connection': + (Connection,), + 'consumer_id': + (str,), + 'app_id': + (str,), + }, + 'attribute_map': { + 'service_id': 'service_id', + 'unified_api': 'unified_api', + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + }, + 'location_map': { + 'service_id': 'path', + 'unified_api': 'path', + 'connection': 'body', + 'consumer_id': 'header', + 'app_id': 'header', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.consumer_request_counts_all_endpoint = _Endpoint( + settings={ + 'response_type': (ConsumerRequestCountsInDateRangeResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/vault/consumers/{consumer_id}/stats', + 'operation_id': 'consumer_request_counts_all', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'consumer_id', + 'start_datetime', + 'end_datetime', + 'app_id', + ], + 'required': [ + 'consumer_id', + 'start_datetime', + 'end_datetime', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'consumer_id': + (str,), + 'start_datetime': + (str,), + 'end_datetime': + (str,), + 'app_id': + (str,), + }, + 'attribute_map': { + 'consumer_id': 'consumer_id', + 'start_datetime': 'start_datetime', + 'end_datetime': 'end_datetime', + 'app_id': 'x-apideck-app-id', + }, + 'location_map': { + 'consumer_id': 'path', + 'start_datetime': 'query', + 'end_datetime': 'query', + 'app_id': 'header', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.consumers_all_endpoint = _Endpoint( + settings={ + 'response_type': (GetConsumersResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/vault/consumers', + 'operation_id': 'consumers_all', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'app_id', + 'cursor', + 'limit', + ], + 'required': [], + 'nullable': [ + 'cursor', + ], + 'enum': [ + ], + 'validation': [ + 'limit', + ] + }, + root_map={ + 'validations': { + ('limit',): { + + 'inclusive_maximum': 200, + 'inclusive_minimum': 1, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'app_id': + (str,), + 'cursor': + (str, none_type,), + 'limit': + (int,), + }, + 'attribute_map': { + 'app_id': 'x-apideck-app-id', + 'cursor': 'cursor', + 'limit': 'limit', + }, + 'location_map': { + 'app_id': 'header', + 'cursor': 'query', + 'limit': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.consumers_one_endpoint = _Endpoint( + settings={ + 'response_type': (GetConsumerResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/vault/consumers/{consumer_id}', + 'operation_id': 'consumers_one', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'consumer_id', + 'app_id', + ], + 'required': [ + 'consumer_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'consumer_id': + (str,), + 'app_id': + (str,), + }, + 'attribute_map': { + 'consumer_id': 'consumer_id', + 'app_id': 'x-apideck-app-id', + }, + 'location_map': { + 'consumer_id': 'path', + 'app_id': 'header', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.logs_all_endpoint = _Endpoint( + settings={ + 'response_type': (GetLogsResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/vault/logs', + 'operation_id': 'logs_all', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'app_id', + 'consumer_id', + 'filter', + 'cursor', + 'limit', + ], + 'required': [], + 'nullable': [ + 'cursor', + ], + 'enum': [ + ], + 'validation': [ + 'limit', + ] + }, + root_map={ + 'validations': { + ('limit',): { + + 'inclusive_maximum': 200, + 'inclusive_minimum': 1, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'app_id': + (str,), + 'consumer_id': + (str,), + 'filter': + (LogsFilter,), + 'cursor': + (str, none_type,), + 'limit': + (int,), + }, + 'attribute_map': { + 'app_id': 'x-apideck-app-id', + 'consumer_id': 'x-apideck-consumer-id', + 'filter': 'filter', + 'cursor': 'cursor', + 'limit': 'limit', + }, + 'location_map': { + 'app_id': 'header', + 'consumer_id': 'header', + 'filter': 'query', + 'cursor': 'query', + 'limit': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.sessions_create_endpoint = _Endpoint( + settings={ + 'response_type': (CreateSessionResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/vault/sessions', + 'operation_id': 'sessions_create', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'consumer_id', + 'app_id', + 'session', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'consumer_id': + (str,), + 'app_id': + (str,), + 'session': + (Session,), + }, + 'attribute_map': { + 'consumer_id': 'x-apideck-consumer-id', + 'app_id': 'x-apideck-app-id', + }, + 'location_map': { + 'consumer_id': 'header', + 'app_id': 'header', + 'session': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + + def connection_settings_all( + self, + unified_api, + service_id, + resource, + **kwargs + ): + """Get resource settings # noqa: E501 + + This endpoint returns custom settings and their defaults required by connection for a given resource. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.connection_settings_all(unified_api, service_id, resource, async_req=True) + >>> result = thread.get() + + Args: + unified_api (str): Unified API + service_id (str): Service ID of the resource to return + resource (str): Resource Name + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + GetConnectionResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['unified_api'] = \ + unified_api + kwargs['service_id'] = \ + service_id + kwargs['resource'] = \ + resource + return self.connection_settings_all_endpoint.call_with_http_info(**kwargs) + + def connection_settings_update( + self, + service_id, + unified_api, + resource, + connection, + **kwargs + ): + """Update settings # noqa: E501 + + Update default values for a connection's resource settings # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.connection_settings_update(service_id, unified_api, resource, connection, async_req=True) + >>> result = thread.get() + + Args: + service_id (str): Service ID of the resource to return + unified_api (str): Unified API + resource (str): Resource Name + connection (Connection): Fields that need to be updated on the resource + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + UpdateConnectionResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['service_id'] = \ + service_id + kwargs['unified_api'] = \ + unified_api + kwargs['resource'] = \ + resource + kwargs['connection'] = \ + connection + return self.connection_settings_update_endpoint.call_with_http_info(**kwargs) + + def connections_all( + self, + **kwargs + ): + """Get all connections # noqa: E501 + + This endpoint includes all the configured integrations and contains the required assets to build an integrations page where your users can install integrations. OAuth2 supported integrations will contain authorize and revoke links to handle the authentication flows. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.connections_all(async_req=True) + >>> result = thread.get() + + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + api (str): Scope results to Unified API. [optional] + configured (bool): Scopes results to connections that have been configured or not. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + GetConnectionsResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + return self.connections_all_endpoint.call_with_http_info(**kwargs) + + def connections_delete( + self, + service_id, + unified_api, + **kwargs + ): + """Deletes a connection # noqa: E501 + + Deletes a connection # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.connections_delete(service_id, unified_api, async_req=True) + >>> result = thread.get() + + Args: + service_id (str): Service ID of the resource to return + unified_api (str): Unified API + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['service_id'] = \ + service_id + kwargs['unified_api'] = \ + unified_api + return self.connections_delete_endpoint.call_with_http_info(**kwargs) + + def connections_import( + self, + service_id, + unified_api, + connection_import_data, + **kwargs + ): + """Import connection # noqa: E501 + + Import an authorized connection. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.connections_import(service_id, unified_api, connection_import_data, async_req=True) + >>> result = thread.get() + + Args: + service_id (str): Service ID of the resource to return + unified_api (str): Unified API + connection_import_data (ConnectionImportData): Fields that need to be persisted on the resource + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + CreateConnectionResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['service_id'] = \ + service_id + kwargs['unified_api'] = \ + unified_api + kwargs['connection_import_data'] = \ + connection_import_data + return self.connections_import_endpoint.call_with_http_info(**kwargs) + + def connections_one( + self, + service_id, + unified_api, + **kwargs + ): + """Get connection # noqa: E501 + + Get a connection # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.connections_one(service_id, unified_api, async_req=True) + >>> result = thread.get() + + Args: + service_id (str): Service ID of the resource to return + unified_api (str): Unified API + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + GetConnectionResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['service_id'] = \ + service_id + kwargs['unified_api'] = \ + unified_api + return self.connections_one_endpoint.call_with_http_info(**kwargs) + + def connections_update( + self, + service_id, + unified_api, + connection, + **kwargs + ): + """Update connection # noqa: E501 + + Update a connection # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.connections_update(service_id, unified_api, connection, async_req=True) + >>> result = thread.get() + + Args: + service_id (str): Service ID of the resource to return + unified_api (str): Unified API + connection (Connection): Fields that need to be updated on the resource + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + UpdateConnectionResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['service_id'] = \ + service_id + kwargs['unified_api'] = \ + unified_api + kwargs['connection'] = \ + connection + return self.connections_update_endpoint.call_with_http_info(**kwargs) + + def consumer_request_counts_all( + self, + consumer_id, + start_datetime, + end_datetime, + **kwargs + ): + """Consumer request counts # noqa: E501 + + Get consumer request counts within a given datetime range. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.consumer_request_counts_all(consumer_id, start_datetime, end_datetime, async_req=True) + >>> result = thread.get() + + Args: + consumer_id (str): ID of the consumer to return + start_datetime (str): Scopes results to requests that happened after datetime + end_datetime (str): Scopes results to requests that happened before datetime + + Keyword Args: + app_id (str): The ID of your Unify application. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + ConsumerRequestCountsInDateRangeResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['consumer_id'] = \ + consumer_id + kwargs['start_datetime'] = \ + start_datetime + kwargs['end_datetime'] = \ + end_datetime + return self.consumer_request_counts_all_endpoint.call_with_http_info(**kwargs) + + def consumers_all( + self, + **kwargs + ): + """Get all consumers # noqa: E501 + + This endpoint includes all application consumers, along with an aggregated count of requests made. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.consumers_all(async_req=True) + >>> result = thread.get() + + + Keyword Args: + app_id (str): The ID of your Unify application. [optional] + cursor (str, none_type): Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.. [optional] + limit (int): Number of records to return. [optional] if omitted the server will use the default value of 20 + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + GetConsumersResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + return self.consumers_all_endpoint.call_with_http_info(**kwargs) + + def consumers_one( + self, + consumer_id, + **kwargs + ): + """Get consumer # noqa: E501 + + Consumer detail including their aggregated counts with the connections they have authorized. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.consumers_one(consumer_id, async_req=True) + >>> result = thread.get() + + Args: + consumer_id (str): ID of the consumer to return + + Keyword Args: + app_id (str): The ID of your Unify application. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + GetConsumerResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['consumer_id'] = \ + consumer_id + return self.consumers_one_endpoint.call_with_http_info(**kwargs) + + def logs_all( + self, + **kwargs + ): + """Get all consumer request logs # noqa: E501 + + This endpoint includes all consumer request logs. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.logs_all(async_req=True) + >>> result = thread.get() + + + Keyword Args: + app_id (str): The ID of your Unify application. [optional] + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + filter (LogsFilter): Filter results. [optional] + cursor (str, none_type): Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.. [optional] + limit (int): Number of records to return. [optional] if omitted the server will use the default value of 20 + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + GetLogsResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + return self.logs_all_endpoint.call_with_http_info(**kwargs) + + def sessions_create( + self, + **kwargs + ): + """Create Session # noqa: E501 + + Making a POST request to this endpoint will initiate a Hosted Vault session. Redirect the consumer to the returned url to allow temporary access to manage their integrations and settings. Note: This is a short lived token that will expire after 1 hour (TTL: 3600). # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.sessions_create(async_req=True) + >>> result = thread.get() + + + Keyword Args: + consumer_id (str): ID of the consumer which you want to get or push data from. [optional] + app_id (str): The ID of your Unify application. [optional] + session (Session): Additional redirect uri and/or consumer metadata. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + CreateSessionResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + return self.sessions_create_endpoint.call_with_http_info(**kwargs) + diff --git a/src/apideck/api/webhook_api.py b/src/apideck/api/webhook_api.py new file mode 100644 index 0000000000..a486409052 --- /dev/null +++ b/src/apideck/api/webhook_api.py @@ -0,0 +1,894 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.api_client import ApiClient, Endpoint as _Endpoint +from apideck.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.create_webhook_request import CreateWebhookRequest +from apideck.model.create_webhook_response import CreateWebhookResponse +from apideck.model.delete_webhook_response import DeleteWebhookResponse +from apideck.model.get_webhook_event_logs_response import GetWebhookEventLogsResponse +from apideck.model.get_webhook_response import GetWebhookResponse +from apideck.model.get_webhooks_response import GetWebhooksResponse +from apideck.model.not_found_response import NotFoundResponse +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.update_webhook_request import UpdateWebhookRequest +from apideck.model.update_webhook_response import UpdateWebhookResponse +from apideck.model.webhook_event_logs_filter import WebhookEventLogsFilter + + +class WebhookApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.event_logs_all_endpoint = _Endpoint( + settings={ + 'response_type': (GetWebhookEventLogsResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/webhook/logs', + 'operation_id': 'event_logs_all', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'app_id', + 'cursor', + 'limit', + 'filter', + ], + 'required': [], + 'nullable': [ + 'cursor', + ], + 'enum': [ + ], + 'validation': [ + 'limit', + ] + }, + root_map={ + 'validations': { + ('limit',): { + + 'inclusive_maximum': 200, + 'inclusive_minimum': 1, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'app_id': + (str,), + 'cursor': + (str, none_type,), + 'limit': + (int,), + 'filter': + (WebhookEventLogsFilter,), + }, + 'attribute_map': { + 'app_id': 'x-apideck-app-id', + 'cursor': 'cursor', + 'limit': 'limit', + 'filter': 'filter', + }, + 'location_map': { + 'app_id': 'header', + 'cursor': 'query', + 'limit': 'query', + 'filter': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.webhooks_add_endpoint = _Endpoint( + settings={ + 'response_type': (CreateWebhookResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/webhook/webhooks', + 'operation_id': 'webhooks_add', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'create_webhook_request', + 'app_id', + ], + 'required': [ + 'create_webhook_request', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'create_webhook_request': + (CreateWebhookRequest,), + 'app_id': + (str,), + }, + 'attribute_map': { + 'app_id': 'x-apideck-app-id', + }, + 'location_map': { + 'create_webhook_request': 'body', + 'app_id': 'header', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.webhooks_all_endpoint = _Endpoint( + settings={ + 'response_type': (GetWebhooksResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/webhook/webhooks', + 'operation_id': 'webhooks_all', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'app_id', + 'cursor', + 'limit', + ], + 'required': [], + 'nullable': [ + 'cursor', + ], + 'enum': [ + ], + 'validation': [ + 'limit', + ] + }, + root_map={ + 'validations': { + ('limit',): { + + 'inclusive_maximum': 200, + 'inclusive_minimum': 1, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'app_id': + (str,), + 'cursor': + (str, none_type,), + 'limit': + (int,), + }, + 'attribute_map': { + 'app_id': 'x-apideck-app-id', + 'cursor': 'cursor', + 'limit': 'limit', + }, + 'location_map': { + 'app_id': 'header', + 'cursor': 'query', + 'limit': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.webhooks_delete_endpoint = _Endpoint( + settings={ + 'response_type': (DeleteWebhookResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/webhook/webhooks/{id}', + 'operation_id': 'webhooks_delete', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'app_id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'app_id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + 'app_id': 'x-apideck-app-id', + }, + 'location_map': { + 'id': 'path', + 'app_id': 'header', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.webhooks_one_endpoint = _Endpoint( + settings={ + 'response_type': (GetWebhookResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/webhook/webhooks/{id}', + 'operation_id': 'webhooks_one', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'app_id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'app_id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + 'app_id': 'x-apideck-app-id', + }, + 'location_map': { + 'id': 'path', + 'app_id': 'header', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.webhooks_update_endpoint = _Endpoint( + settings={ + 'response_type': (UpdateWebhookResponse,), + 'auth': [ + 'apiKey' + ], + 'endpoint_path': '/webhook/webhooks/{id}', + 'operation_id': 'webhooks_update', + 'http_method': 'PATCH', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'update_webhook_request', + 'app_id', + ], + 'required': [ + 'id', + 'update_webhook_request', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'update_webhook_request': + (UpdateWebhookRequest,), + 'app_id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + 'app_id': 'x-apideck-app-id', + }, + 'location_map': { + 'id': 'path', + 'update_webhook_request': 'body', + 'app_id': 'header', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + + def event_logs_all( + self, + **kwargs + ): + """List event logs # noqa: E501 + + List event logs # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.event_logs_all(async_req=True) + >>> result = thread.get() + + + Keyword Args: + app_id (str): The ID of your Unify application. [optional] + cursor (str, none_type): Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.. [optional] + limit (int): Number of records to return. [optional] if omitted the server will use the default value of 20 + filter (WebhookEventLogsFilter): Filter results. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + GetWebhookEventLogsResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + return self.event_logs_all_endpoint.call_with_http_info(**kwargs) + + def webhooks_add( + self, + create_webhook_request, + **kwargs + ): + """Create webhook subscription # noqa: E501 + + Create a webhook subscription to receive events # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.webhooks_add(create_webhook_request, async_req=True) + >>> result = thread.get() + + Args: + create_webhook_request (CreateWebhookRequest): + + Keyword Args: + app_id (str): The ID of your Unify application. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + CreateWebhookResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['create_webhook_request'] = \ + create_webhook_request + return self.webhooks_add_endpoint.call_with_http_info(**kwargs) + + def webhooks_all( + self, + **kwargs + ): + """List webhook subscriptions # noqa: E501 + + List all webhook subscriptions # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.webhooks_all(async_req=True) + >>> result = thread.get() + + + Keyword Args: + app_id (str): The ID of your Unify application. [optional] + cursor (str, none_type): Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.. [optional] + limit (int): Number of records to return. [optional] if omitted the server will use the default value of 20 + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + GetWebhooksResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + return self.webhooks_all_endpoint.call_with_http_info(**kwargs) + + def webhooks_delete( + self, + id, + **kwargs + ): + """Delete webhook subscription # noqa: E501 + + Delete a webhook subscription # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.webhooks_delete(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): JWT Webhook token that represents the unifiedApi and applicationId associated to the event source. + + Keyword Args: + app_id (str): The ID of your Unify application. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + DeleteWebhookResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + return self.webhooks_delete_endpoint.call_with_http_info(**kwargs) + + def webhooks_one( + self, + id, + **kwargs + ): + """Get webhook subscription # noqa: E501 + + Get the webhook subscription details # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.webhooks_one(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): JWT Webhook token that represents the unifiedApi and applicationId associated to the event source. + + Keyword Args: + app_id (str): The ID of your Unify application. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + GetWebhookResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + return self.webhooks_one_endpoint.call_with_http_info(**kwargs) + + def webhooks_update( + self, + id, + update_webhook_request, + **kwargs + ): + """Update webhook subscription # noqa: E501 + + Update a webhook subscription # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.webhooks_update(id, update_webhook_request, async_req=True) + >>> result = thread.get() + + Args: + id (str): JWT Webhook token that represents the unifiedApi and applicationId associated to the event source. + update_webhook_request (UpdateWebhookRequest): + + Keyword Args: + app_id (str): The ID of your Unify application. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + UpdateWebhookResponse + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['id'] = \ + id + kwargs['update_webhook_request'] = \ + update_webhook_request + return self.webhooks_update_endpoint.call_with_http_info(**kwargs) + diff --git a/src/apideck/api_client.py b/src/apideck/api_client.py new file mode 100644 index 0000000000..d52a9032c1 --- /dev/null +++ b/src/apideck/api_client.py @@ -0,0 +1,900 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import json +import atexit +import mimetypes +from multiprocessing.pool import ThreadPool +import io +import os +import re +import typing +from urllib.parse import quote +from urllib3.fields import RequestField + + +from apideck import rest +from apideck.configuration import Configuration +from apideck.exceptions import ApiTypeError, ApiValueError, ApiException +from apideck.model_utils import ( + ModelNormal, + ModelSimple, + ModelComposed, + check_allowed_values, + check_validations, + date, + datetime, + deserialize_file, + file_type, + model_to_dict, + none_type, + validate_and_convert_types +) + + +class ApiClient(object): + """Generic API client for OpenAPI client library builds. + + OpenAPI generic API client. This client handles the client- + server communication, and is invariant across implementations. Specifics of + the methods and models for each application are generated from the OpenAPI + templates. + + NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + Do not edit the class manually. + + :param configuration: .Configuration object for this client + :param header_name: a header to pass when making calls to the API. + :param header_value: a header value to pass when making calls to + the API. + :param cookie: a cookie to include in the header when making calls + to the API + :param pool_threads: The number of threads to use for async requests + to the API. More threads means more concurrent API requests. + """ + + _pool = None + + def __init__(self, configuration=None, header_name=None, header_value=None, + cookie=None, pool_threads=1): + if configuration is None: + configuration = Configuration.get_default_copy() + self.configuration = configuration + self.pool_threads = pool_threads + + self.rest_client = rest.RESTClientObject(configuration) + self.default_headers = {} + if header_name is not None: + self.default_headers[header_name] = header_value + self.cookie = cookie + # Set default User-Agent. + self.user_agent = 'OpenAPI-Generator/0.0.1/python' + + def __enter__(self): + return self + + def __exit__(self, exc_type, exc_value, traceback): + self.close() + + def close(self): + if self._pool: + self._pool.close() + self._pool.join() + self._pool = None + if hasattr(atexit, 'unregister'): + atexit.unregister(self.close) + + @property + def pool(self): + """Create thread pool on first request + avoids instantiating unused threadpool for blocking clients. + """ + if self._pool is None: + atexit.register(self.close) + self._pool = ThreadPool(self.pool_threads) + return self._pool + + @property + def user_agent(self): + """User agent for this API client""" + return self.default_headers['User-Agent'] + + @user_agent.setter + def user_agent(self, value): + self.default_headers['User-Agent'] = value + + def set_default_header(self, header_name, header_value): + self.default_headers[header_name] = header_value + + def __call_api( + self, + resource_path: str, + method: str, + path_params: typing.Optional[typing.Dict[str, typing.Any]] = None, + query_params: typing.Optional[typing.List[typing.Tuple[str, typing.Any]]] = None, + header_params: typing.Optional[typing.Dict[str, typing.Any]] = None, + body: typing.Optional[typing.Any] = None, + post_params: typing.Optional[typing.List[typing.Tuple[str, typing.Any]]] = None, + files: typing.Optional[typing.Dict[str, typing.List[io.IOBase]]] = None, + response_type: typing.Optional[typing.Tuple[typing.Any]] = None, + auth_settings: typing.Optional[typing.List[str]] = None, + _return_http_data_only: typing.Optional[bool] = None, + collection_formats: typing.Optional[typing.Dict[str, str]] = None, + _preload_content: bool = True, + _request_timeout: typing.Optional[typing.Union[int, float, typing.Tuple]] = None, + _host: typing.Optional[str] = None, + _check_type: typing.Optional[bool] = None, + _content_type: typing.Optional[str] = None + ): + + config = self.configuration + + # header parameters + header_params = header_params or {} + header_params.update(self.default_headers) + if self.cookie: + header_params['Cookie'] = self.cookie + if header_params: + header_params = self.sanitize_for_serialization(header_params) + header_params = dict(self.parameters_to_tuples(header_params, + collection_formats)) + + # path parameters + if path_params: + path_params = self.sanitize_for_serialization(path_params) + path_params = self.parameters_to_tuples(path_params, + collection_formats) + for k, v in path_params: + # specified safe chars, encode everything + resource_path = resource_path.replace( + '{%s}' % k, + quote(str(v), safe=config.safe_chars_for_path_param) + ) + + # query parameters + if query_params: + query_params = self.sanitize_for_serialization(query_params) + query_params = self.parameters_to_tuples(query_params, + collection_formats) + + # post parameters + if post_params or files: + post_params = post_params if post_params else [] + post_params = self.sanitize_for_serialization(post_params) + post_params = self.parameters_to_tuples(post_params, + collection_formats) + post_params.extend(self.files_parameters(files)) + if header_params['Content-Type'].startswith("multipart"): + post_params = self.parameters_to_multipart(post_params, + (dict) ) + + # body + if body: + body = self.sanitize_for_serialization(body) + + # auth setting + self.update_params_for_auth(header_params, query_params, + auth_settings, resource_path, method, body) + + # request url + if _host is None: + url = self.configuration.host + resource_path + else: + # use server/host defined in path or operation instead + url = _host + resource_path + + # transform filters + + def transform_tuples(tuple_list): + # initialize an empty list + new_list = [] + + # loop through each tuple in the input list + for tup in tuple_list: + # if the tuple's first element is 'filter', + # then process the dictionary value from the second element + if tup[0] == 'filter': + for key, value in tup[1].items(): + new_list.append(('filter[' + key + ']', value)) + # if the tuple's first element is 'sort', + elif tup[0] == 'sort': + for key, value in tup[1].items(): + new_list.append(('sort[' + key + ']', value)) + # if the tuple's first element is 'raw', + elif tup[0] == 'raw': + new_list.append((tup[0], str(tup[1]).lower())) + + # then simply append it to the new list + else: + new_list.append(tup) + + # return the new list + return new_list + + # transform the tuples and print the result + result = transform_tuples(query_params) + + query_params = result + print(query_params) + + try: + # perform request and return response + response_data = self.request( + method, url, query_params=query_params, headers=header_params, + post_params=post_params, body=body, + _preload_content=_preload_content, + _request_timeout=_request_timeout) + except ApiException as e: + e.body = e.body.decode('utf-8') + raise e + + self.last_response = response_data + + return_data = response_data + + if not _preload_content: + return (return_data) + return return_data + + # deserialize response data + if response_type: + if response_type != (file_type,): + encoding = "utf-8" + content_type = response_data.getheader('content-type') + if content_type is not None: + match = re.search(r"charset=([a-zA-Z\-\d]+)[\s\;]?", content_type) + if match: + encoding = match.group(1) + response_data.data = response_data.data.decode(encoding) + + return_data = self.deserialize( + response_data, + response_type, + _check_type + ) + else: + return_data = None + + if _return_http_data_only: + return (return_data) + else: + return (return_data, response_data.status, + response_data.getheaders()) + + def parameters_to_multipart(self, params, collection_types): + """Get parameters as list of tuples, formatting as json if value is collection_types + + :param params: Parameters as list of two-tuples + :param dict collection_types: Parameter collection types + :return: Parameters as list of tuple or urllib3.fields.RequestField + """ + new_params = [] + if collection_types is None: + collection_types = (dict) + for k, v in params.items() if isinstance(params, dict) else params: # noqa: E501 + if isinstance(v, collection_types): # v is instance of collection_type, formatting as application/json + v = json.dumps(v, ensure_ascii=False).encode("utf-8") + field = RequestField(k, v) + field.make_multipart(content_type="application/json; charset=utf-8") + new_params.append(field) + else: + new_params.append((k, v)) + return new_params + + @classmethod + def sanitize_for_serialization(cls, obj): + """Prepares data for transmission before it is sent with the rest client + If obj is None, return None. + If obj is str, int, long, float, bool, return directly. + If obj is datetime.datetime, datetime.date + convert to string in iso8601 format. + If obj is list, sanitize each element in the list. + If obj is dict, return the dict. + If obj is OpenAPI model, return the properties dict. + If obj is io.IOBase, return the bytes + :param obj: The data to serialize. + :return: The serialized form of data. + """ + if isinstance(obj, (ModelNormal, ModelComposed)): + return { + key: cls.sanitize_for_serialization(val) for key, val in model_to_dict(obj, serialize=True).items() + } + elif isinstance(obj, io.IOBase): + return cls.get_file_data_and_close_file(obj) + elif isinstance(obj, (str, int, float, none_type, bool)): + return obj + elif isinstance(obj, (datetime, date)): + return obj.isoformat() + elif isinstance(obj, ModelSimple): + return cls.sanitize_for_serialization(obj.value) + elif isinstance(obj, (list, tuple)): + return [cls.sanitize_for_serialization(item) for item in obj] + if isinstance(obj, dict): + return {key: cls.sanitize_for_serialization(val) for key, val in obj.items()} + raise ApiValueError('Unable to prepare type {} for serialization'.format(obj.__class__.__name__)) + + def deserialize(self, response, response_type, _check_type): + """Deserializes response into an object. + + :param response: RESTResponse object to be deserialized. + :param response_type: For the response, a tuple containing: + valid classes + a list containing valid classes (for list schemas) + a dict containing a tuple of valid classes as the value + Example values: + (str,) + (Pet,) + (float, none_type) + ([int, none_type],) + ({str: (bool, str, int, float, date, datetime, str, none_type)},) + :param _check_type: boolean, whether to check the types of the data + received from the server + :type _check_type: bool + + :return: deserialized object. + """ + # handle file downloading + # save response body into a tmp file and return the instance + if response_type == (file_type,): + content_disposition = response.getheader("Content-Disposition") + return deserialize_file(response.data, self.configuration, + content_disposition=content_disposition) + + # fetch data from response object + try: + received_data = json.loads(response.data) + except ValueError: + received_data = response.data + + # store our data under the key of 'received_data' so users have some + # context if they are deserializing a string and the data type is wrong + deserialized_data = validate_and_convert_types( + received_data, + response_type, + ['received_data'], + True, + _check_type, + configuration=self.configuration + ) + return deserialized_data + + def call_api( + self, + resource_path: str, + method: str, + path_params: typing.Optional[typing.Dict[str, typing.Any]] = None, + query_params: typing.Optional[typing.List[typing.Tuple[str, typing.Any]]] = None, + header_params: typing.Optional[typing.Dict[str, typing.Any]] = None, + body: typing.Optional[typing.Any] = None, + post_params: typing.Optional[typing.List[typing.Tuple[str, typing.Any]]] = None, + files: typing.Optional[typing.Dict[str, typing.List[io.IOBase]]] = None, + response_type: typing.Optional[typing.Tuple[typing.Any]] = None, + auth_settings: typing.Optional[typing.List[str]] = None, + async_req: typing.Optional[bool] = None, + _return_http_data_only: typing.Optional[bool] = None, + collection_formats: typing.Optional[typing.Dict[str, str]] = None, + _preload_content: bool = True, + _request_timeout: typing.Optional[typing.Union[int, float, typing.Tuple]] = None, + _host: typing.Optional[str] = None, + _check_type: typing.Optional[bool] = None + ): + """Makes the HTTP request (synchronous) and returns deserialized data. + + To make an async_req request, set the async_req parameter. + + :param resource_path: Path to method endpoint. + :param method: Method to call. + :param path_params: Path parameters in the url. + :param query_params: Query parameters in the url. + :param header_params: Header parameters to be + placed in the request header. + :param body: Request body. + :param post_params dict: Request post form parameters, + for `application/x-www-form-urlencoded`, `multipart/form-data`. + :param auth_settings list: Auth Settings names for the request. + :param response_type: For the response, a tuple containing: + valid classes + a list containing valid classes (for list schemas) + a dict containing a tuple of valid classes as the value + Example values: + (str,) + (Pet,) + (float, none_type) + ([int, none_type],) + ({str: (bool, str, int, float, date, datetime, str, none_type)},) + :param files: key -> field name, value -> a list of open file + objects for `multipart/form-data`. + :type files: dict + :param async_req bool: execute request asynchronously + :type async_req: bool, optional + :param _return_http_data_only: response data without head status code + and headers + :type _return_http_data_only: bool, optional + :param collection_formats: dict of collection formats for path, query, + header, and post parameters. + :type collection_formats: dict, optional + :param _preload_content: if False, the urllib3.HTTPResponse object will + be returned without reading/decoding response + data. Default is True. + :type _preload_content: bool, optional + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :param _check_type: boolean describing if the data back from the server + should have its type checked. + :type _check_type: bool, optional + :return: + If async_req parameter is True, + the request will be called asynchronously. + The method will return the request thread. + If parameter async_req is False or missing, + then the method will return the response directly. + """ + if not async_req: + return self.__call_api(resource_path, method, + path_params, query_params, header_params, + body, post_params, files, + response_type, auth_settings, + _return_http_data_only, collection_formats, + _preload_content, _request_timeout, _host, + _check_type) + + return self.pool.apply_async(self.__call_api, (resource_path, + method, path_params, + query_params, + header_params, body, + post_params, files, + response_type, + auth_settings, + _return_http_data_only, + collection_formats, + _preload_content, + _request_timeout, + _host, _check_type)) + + def request(self, method, url, query_params=None, headers=None, + post_params=None, body=None, _preload_content=True, + _request_timeout=None): + """Makes the HTTP request using RESTClient.""" + if method == "GET": + return self.rest_client.GET(url, + query_params=query_params, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + headers=headers) + elif method == "HEAD": + return self.rest_client.HEAD(url, + query_params=query_params, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + headers=headers) + elif method == "OPTIONS": + return self.rest_client.OPTIONS(url, + query_params=query_params, + headers=headers, + post_params=post_params, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + body=body) + elif method == "POST": + return self.rest_client.POST(url, + query_params=query_params, + headers=headers, + post_params=post_params, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + body=body) + elif method == "PUT": + return self.rest_client.PUT(url, + query_params=query_params, + headers=headers, + post_params=post_params, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + body=body) + elif method == "PATCH": + return self.rest_client.PATCH(url, + query_params=query_params, + headers=headers, + post_params=post_params, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + body=body) + elif method == "DELETE": + return self.rest_client.DELETE(url, + query_params=query_params, + headers=headers, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + body=body) + else: + raise ApiValueError( + "http method must be `GET`, `HEAD`, `OPTIONS`," + " `POST`, `PATCH`, `PUT` or `DELETE`." + ) + + def parameters_to_tuples(self, params, collection_formats): + """Get parameters as list of tuples, formatting collections. + + :param params: Parameters as dict or list of two-tuples + :param dict collection_formats: Parameter collection formats + :return: Parameters as list of tuples, collections formatted + """ + new_params = [] + if collection_formats is None: + collection_formats = {} + for k, v in params.items() if isinstance(params, dict) else params: # noqa: E501 + if k in collection_formats: + collection_format = collection_formats[k] + if collection_format == 'multi': + new_params.extend((k, value) for value in v) + else: + if collection_format == 'ssv': + delimiter = ' ' + elif collection_format == 'tsv': + delimiter = '\t' + elif collection_format == 'pipes': + delimiter = '|' + else: # csv is the default + delimiter = ',' + new_params.append( + (k, delimiter.join(str(value) for value in v))) + else: + new_params.append((k, v)) + return new_params + + @staticmethod + def get_file_data_and_close_file(file_instance: io.IOBase) -> bytes: + file_data = file_instance.read() + file_instance.close() + return file_data + + def files_parameters(self, files: typing.Optional[typing.Dict[str, typing.List[io.IOBase]]] = None): + """Builds form parameters. + + :param files: None or a dict with key=param_name and + value is a list of open file objects + :return: List of tuples of form parameters with file data + """ + if files is None: + return [] + + params = [] + for param_name, file_instances in files.items(): + if file_instances is None: + # if the file field is nullable, skip None values + continue + for file_instance in file_instances: + if file_instance is None: + # if the file field is nullable, skip None values + continue + if file_instance.closed is True: + raise ApiValueError( + "Cannot read a closed file. The passed in file_type " + "for %s must be open." % param_name + ) + filename = os.path.basename(file_instance.name) + filedata = self.get_file_data_and_close_file(file_instance) + mimetype = (mimetypes.guess_type(filename)[0] or + 'application/octet-stream') + params.append( + tuple([param_name, tuple([filename, filedata, mimetype])])) + + return params + + def select_header_accept(self, accepts): + """Returns `Accept` based on an array of accepts provided. + + :param accepts: List of headers. + :return: Accept (e.g. application/json). + """ + if not accepts: + return + + accepts = [x.lower() for x in accepts] + + if 'application/json' in accepts: + return 'application/json' + else: + return ', '.join(accepts) + + def select_header_content_type(self, content_types, method=None, body=None): + """Returns `Content-Type` based on an array of content_types provided. + + :param content_types: List of content-types. + :param method: http method (e.g. POST, PATCH). + :param body: http body to send. + :return: Content-Type (e.g. application/json). + """ + if not content_types: + return 'application/json' + + content_types = [x.lower() for x in content_types] + + if (method == 'PATCH' and + 'application/json-patch+json' in content_types and + isinstance(body, list)): + return 'application/json-patch+json' + + if 'application/json' in content_types or '*/*' in content_types: + return 'application/json' + else: + return content_types[0] + + def update_params_for_auth(self, headers, queries, auth_settings, + resource_path, method, body): + """Updates header and query params based on authentication setting. + + :param headers: Header parameters dict to be updated. + :param queries: Query parameters tuple list to be updated. + :param auth_settings: Authentication setting identifiers list. + :param resource_path: A string representation of the HTTP request resource path. + :param method: A string representation of the HTTP request method. + :param body: A object representing the body of the HTTP request. + The object type is the return value of _encoder.default(). + """ + if not auth_settings: + return + + for auth in auth_settings: + auth_setting = self.configuration.auth_settings().get(auth) + if auth_setting: + if auth_setting['in'] == 'cookie': + headers['Cookie'] = auth_setting['value'] + elif auth_setting['in'] == 'header': + if auth_setting['type'] != 'http-signature': + headers[auth_setting['key']] = auth_setting['value'] + elif auth_setting['in'] == 'query': + queries.append((auth_setting['key'], auth_setting['value'])) + else: + raise ApiValueError( + 'Authentication token must be in `query` or `header`' + ) + + +class Endpoint(object): + def __init__(self, settings=None, params_map=None, root_map=None, + headers_map=None, api_client=None, callable=None): + """Creates an endpoint + + Args: + settings (dict): see below key value pairs + 'response_type' (tuple/None): response type + 'auth' (list): a list of auth type keys + 'endpoint_path' (str): the endpoint path + 'operation_id' (str): endpoint string identifier + 'http_method' (str): POST/PUT/PATCH/GET etc + 'servers' (list): list of str servers that this endpoint is at + params_map (dict): see below key value pairs + 'all' (list): list of str endpoint parameter names + 'required' (list): list of required parameter names + 'nullable' (list): list of nullable parameter names + 'enum' (list): list of parameters with enum values + 'validation' (list): list of parameters with validations + root_map + 'validations' (dict): the dict mapping endpoint parameter tuple + paths to their validation dictionaries + 'allowed_values' (dict): the dict mapping endpoint parameter + tuple paths to their allowed_values (enum) dictionaries + 'openapi_types' (dict): param_name to openapi type + 'attribute_map' (dict): param_name to camelCase name + 'location_map' (dict): param_name to 'body', 'file', 'form', + 'header', 'path', 'query' + collection_format_map (dict): param_name to `csv` etc. + headers_map (dict): see below key value pairs + 'accept' (list): list of Accept header strings + 'content_type' (list): list of Content-Type header strings + api_client (ApiClient) api client instance + callable (function): the function which is invoked when the + Endpoint is called + """ + self.settings = settings + self.params_map = params_map + self.params_map['all'].extend([ + 'async_req', + '_host_index', + '_preload_content', + '_request_timeout', + '_return_http_data_only', + '_check_input_type', + '_check_return_type', + '_content_type', + '_spec_property_naming' + ]) + self.params_map['nullable'].extend(['_request_timeout']) + self.validations = root_map['validations'] + self.allowed_values = root_map['allowed_values'] + self.openapi_types = root_map['openapi_types'] + extra_types = { + 'async_req': (bool,), + '_host_index': (none_type, int), + '_preload_content': (bool,), + '_request_timeout': (none_type, float, (float,), [float], int, (int,), [int]), + '_return_http_data_only': (bool,), + '_check_input_type': (bool,), + '_check_return_type': (bool,), + '_spec_property_naming': (bool,), + '_content_type': (none_type, str) + } + self.openapi_types.update(extra_types) + self.attribute_map = root_map['attribute_map'] + self.location_map = root_map['location_map'] + self.collection_format_map = root_map['collection_format_map'] + self.headers_map = headers_map + self.api_client = api_client + self.callable = callable + + def __validate_inputs(self, kwargs): + for param in self.params_map['enum']: + if param in kwargs: + check_allowed_values( + self.allowed_values, + (param,), + kwargs[param] + ) + + for param in self.params_map['validation']: + if param in kwargs: + check_validations( + self.validations, + (param,), + kwargs[param], + configuration=self.api_client.configuration + ) + + if kwargs['_check_input_type'] is False: + return + + for key, value in kwargs.items(): + fixed_val = validate_and_convert_types( + value, + self.openapi_types[key], + [key], + kwargs['_spec_property_naming'], + kwargs['_check_input_type'], + configuration=self.api_client.configuration + ) + kwargs[key] = fixed_val + + def __gather_params(self, kwargs): + params = { + 'body': None, + 'collection_format': {}, + 'file': {}, + 'form': [], + 'header': {}, + 'path': {}, + 'query': [] + } + + for param_name, param_value in kwargs.items(): + param_location = self.location_map.get(param_name) + if param_location is None: + continue + if param_location: + if param_location == 'body': + params['body'] = param_value + continue + base_name = self.attribute_map[param_name] + if (param_location == 'form' and + self.openapi_types[param_name] == (file_type,)): + params['file'][base_name] = [param_value] + elif (param_location == 'form' and + self.openapi_types[param_name] == ([file_type],)): + # param_value is already a list + params['file'][base_name] = param_value + elif param_location in {'form', 'query'}: + param_value_full = (base_name, param_value) + params[param_location].append(param_value_full) + if param_location not in {'form', 'query'}: + params[param_location][base_name] = param_value + collection_format = self.collection_format_map.get(param_name) + if collection_format: + params['collection_format'][base_name] = collection_format + + return params + + def __call__(self, *args, **kwargs): + """ This method is invoked when endpoints are called + Example: + + api_instance = AccountingApi() + api_instance.balance_sheet_one # this is an instance of the class Endpoint + api_instance.balance_sheet_one() # this invokes api_instance.balance_sheet_one.__call__() + which then invokes the callable functions stored in that endpoint at + api_instance.balance_sheet_one.callable or self.callable in this class + + """ + return self.callable(self, *args, **kwargs) + + def call_with_http_info(self, **kwargs): + + try: + index = self.api_client.configuration.server_operation_index.get( + self.settings['operation_id'], self.api_client.configuration.server_index + ) if kwargs['_host_index'] is None else kwargs['_host_index'] + server_variables = self.api_client.configuration.server_operation_variables.get( + self.settings['operation_id'], self.api_client.configuration.server_variables + ) + _host = self.api_client.configuration.get_host_from_settings( + index, variables=server_variables, servers=self.settings['servers'] + ) + except IndexError: + if self.settings['servers']: + raise ApiValueError( + "Invalid host index. Must be 0 <= index < %s" % + len(self.settings['servers']) + ) + _host = None + + for key, value in kwargs.items(): + if key not in self.params_map['all']: + raise ApiTypeError( + "Got an unexpected parameter '%s'" + " to method `%s`" % + (key, self.settings['operation_id']) + ) + # only throw this nullable ApiValueError if _check_input_type + # is False, if _check_input_type==True we catch this case + # in self.__validate_inputs + if (key not in self.params_map['nullable'] and value is None + and kwargs['_check_input_type'] is False): + raise ApiValueError( + "Value may not be None for non-nullable parameter `%s`" + " when calling `%s`" % + (key, self.settings['operation_id']) + ) + + for key in self.params_map['required']: + if key not in kwargs.keys(): + raise ApiValueError( + "Missing the required parameter `%s` when calling " + "`%s`" % (key, self.settings['operation_id']) + ) + + self.__validate_inputs(kwargs) + + params = self.__gather_params(kwargs) + + accept_headers_list = self.headers_map['accept'] + if accept_headers_list: + params['header']['Accept'] = self.api_client.select_header_accept( + accept_headers_list) + + if kwargs.get('_content_type'): + params['header']['Content-Type'] = kwargs['_content_type'] + else: + content_type_headers_list = self.headers_map['content_type'] + if content_type_headers_list: + if params['body'] != "": + header_list = self.api_client.select_header_content_type( + content_type_headers_list, self.settings['http_method'], + params['body']) + params['header']['Content-Type'] = header_list + + return self.api_client.call_api( + self.settings['endpoint_path'], self.settings['http_method'], + params['path'], + params['query'], + params['header'], + body=params['body'], + post_params=params['form'], + files=params['file'], + response_type=self.settings['response_type'], + auth_settings=self.settings['auth'], + async_req=kwargs['async_req'], + _check_type=kwargs['_check_return_type'], + _return_http_data_only=kwargs['_return_http_data_only'], + _preload_content=kwargs['_preload_content'], + _request_timeout=kwargs['_request_timeout'], + _host=_host, + collection_formats=params['collection_format']) diff --git a/src/apideck/apis/__init__.py b/src/apideck/apis/__init__.py new file mode 100644 index 0000000000..5426b59083 --- /dev/null +++ b/src/apideck/apis/__init__.py @@ -0,0 +1,28 @@ + +# flake8: noqa + +# Import all APIs into this package. +# If you have many APIs here with many many models used in each API this may +# raise a `RecursionError`. +# In order to avoid this, import only the API that you directly need like: +# +# from .api.accounting_api import AccountingApi +# +# or import this package, but before doing it, use: +# +# import sys +# sys.setrecursionlimit(n) + +# Import APIs into API package: +from apideck.api.accounting_api import AccountingApi +from apideck.api.ats_api import AtsApi +from apideck.api.connector_api import ConnectorApi +from apideck.api.crm_api import CrmApi +from apideck.api.customer_support_api import CustomerSupportApi +from apideck.api.file_storage_api import FileStorageApi +from apideck.api.hris_api import HrisApi +from apideck.api.lead_api import LeadApi +from apideck.api.pos_api import PosApi +from apideck.api.sms_api import SmsApi +from apideck.api.vault_api import VaultApi +from apideck.api.webhook_api import WebhookApi diff --git a/src/apideck/configuration.py b/src/apideck/configuration.py new file mode 100644 index 0000000000..c6e7230650 --- /dev/null +++ b/src/apideck/configuration.py @@ -0,0 +1,493 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import copy +import logging +import multiprocessing +import sys +import urllib3 + +from http import client as http_client +from apideck.exceptions import ApiValueError + + +JSON_SCHEMA_VALIDATION_KEYWORDS = { + 'multipleOf', 'maximum', 'exclusiveMaximum', + 'minimum', 'exclusiveMinimum', 'maxLength', + 'minLength', 'pattern', 'maxItems', 'minItems' +} + +class Configuration(object): + """NOTE: This class is auto generated by OpenAPI Generator + + Ref: https://openapi-generator.tech + Do not edit the class manually. + + :param host: Base url + :param api_key: Dict to store API key(s). + Each entry in the dict specifies an API key. + The dict key is the name of the security scheme in the OAS specification. + The dict value is the API key secret. + :param api_key_prefix: Dict to store API prefix (e.g. Bearer) + The dict key is the name of the security scheme in the OAS specification. + The dict value is an API key prefix when generating the auth data. + :param username: Username for HTTP basic authentication + :param password: Password for HTTP basic authentication + :param discard_unknown_keys: Boolean value indicating whether to discard + unknown properties. A server may send a response that includes additional + properties that are not known by the client in the following scenarios: + 1. The OpenAPI document is incomplete, i.e. it does not match the server + implementation. + 2. The client was generated using an older version of the OpenAPI document + and the server has been upgraded since then. + If a schema in the OpenAPI document defines the additionalProperties attribute, + then all undeclared properties received by the server are injected into the + additional properties map. In that case, there are undeclared properties, and + nothing to discard. + :param disabled_client_side_validations (string): Comma-separated list of + JSON schema validation keywords to disable JSON schema structural validation + rules. The following keywords may be specified: multipleOf, maximum, + exclusiveMaximum, minimum, exclusiveMinimum, maxLength, minLength, pattern, + maxItems, minItems. + By default, the validation is performed for data generated locally by the client + and data received from the server, independent of any validation performed by + the server side. If the input data does not satisfy the JSON schema validation + rules specified in the OpenAPI document, an exception is raised. + If disabled_client_side_validations is set, structural validation is + disabled. This can be useful to troubleshoot data validation problem, such as + when the OpenAPI document validation rules do not match the actual API data + received by the server. + :param server_index: Index to servers configuration. + :param server_variables: Mapping with string values to replace variables in + templated server configuration. The validation of enums is performed for + variables with defined enum values before. + :param server_operation_index: Mapping from operation ID to an index to server + configuration. + :param server_operation_variables: Mapping from operation ID to a mapping with + string values to replace variables in templated server configuration. + The validation of enums is performed for variables with defined enum values before. + :param ssl_ca_cert: str - the path to a file of concatenated CA certificates + in PEM format + + :Example: + + API Key Authentication Example. + Given the following security scheme in the OpenAPI specification: + components: + securitySchemes: + cookieAuth: # name for the security scheme + type: apiKey + in: cookie + name: JSESSIONID # cookie name + + You can programmatically set the cookie: + +conf = apideck.Configuration( + api_key={'cookieAuth': 'abc123'} + api_key_prefix={'cookieAuth': 'JSESSIONID'} +) + + The following cookie will be added to the HTTP request: + Cookie: JSESSIONID abc123 + """ + + _default = None + + def __init__(self, host=None, + api_key=None, api_key_prefix=None, + access_token=None, + username=None, password=None, + discard_unknown_keys=False, + disabled_client_side_validations="", + server_index=None, server_variables=None, + server_operation_index=None, server_operation_variables=None, + ssl_ca_cert=None, + ): + """Constructor + """ + self._base_path = "https://unify.apideck.com" if host is None else host + """Default Base url + """ + self.server_index = 0 if server_index is None and host is None else server_index + self.server_operation_index = server_operation_index or {} + """Default server index + """ + self.server_variables = server_variables or {} + self.server_operation_variables = server_operation_variables or {} + """Default server variables + """ + self.temp_folder_path = None + """Temp file folder for downloading files + """ + # Authentication Settings + self.access_token = access_token + self.api_key = {} + if api_key: + self.api_key = api_key + """dict to store API key(s) + """ + self.api_key_prefix = {} + if api_key_prefix: + self.api_key_prefix = api_key_prefix + """dict to store API prefix (e.g. Bearer) + """ + self.refresh_api_key_hook = None + """function hook to refresh API key if expired + """ + self.username = username + """Username for HTTP basic authentication + """ + self.password = password + """Password for HTTP basic authentication + """ + self.discard_unknown_keys = discard_unknown_keys + self.disabled_client_side_validations = disabled_client_side_validations + self.logger = {} + """Logging Settings + """ + self.logger["package_logger"] = logging.getLogger("apideck") + self.logger["urllib3_logger"] = logging.getLogger("urllib3") + self.logger_format = '%(asctime)s %(levelname)s %(message)s' + """Log format + """ + self.logger_stream_handler = None + """Log stream handler + """ + self.logger_file_handler = None + """Log file handler + """ + self.logger_file = None + """Debug file location + """ + self.debug = False + """Debug switch + """ + + self.verify_ssl = True + """SSL/TLS verification + Set this to false to skip verifying SSL certificate when calling API + from https server. + """ + self.ssl_ca_cert = ssl_ca_cert + """Set this to customize the certificate file to verify the peer. + """ + self.cert_file = None + """client certificate file + """ + self.key_file = None + """client key file + """ + self.assert_hostname = None + """Set this to True/False to enable/disable SSL hostname verification. + """ + + self.connection_pool_maxsize = multiprocessing.cpu_count() * 5 + """urllib3 connection pool's maximum number of connections saved + per pool. urllib3 uses 1 connection as default value, but this is + not the best value when you are making a lot of possibly parallel + requests to the same host, which is often the case here. + cpu_count * 5 is used as default value to increase performance. + """ + + self.proxy = None + """Proxy URL + """ + self.no_proxy = None + """bypass proxy for host in the no_proxy list. + """ + self.proxy_headers = None + """Proxy headers + """ + self.safe_chars_for_path_param = '' + """Safe chars for path_param + """ + self.retries = None + """Adding retries to override urllib3 default value 3 + """ + # Enable client side validation + self.client_side_validation = True + + # Options to pass down to the underlying urllib3 socket + self.socket_options = None + + def __deepcopy__(self, memo): + cls = self.__class__ + result = cls.__new__(cls) + memo[id(self)] = result + for k, v in self.__dict__.items(): + if k not in ('logger', 'logger_file_handler'): + setattr(result, k, copy.deepcopy(v, memo)) + # shallow copy of loggers + result.logger = copy.copy(self.logger) + # use setters to configure loggers + result.logger_file = self.logger_file + result.debug = self.debug + return result + + def __setattr__(self, name, value): + object.__setattr__(self, name, value) + if name == 'disabled_client_side_validations': + s = set(filter(None, value.split(','))) + for v in s: + if v not in JSON_SCHEMA_VALIDATION_KEYWORDS: + raise ApiValueError( + "Invalid keyword: '{0}''".format(v)) + self._disabled_client_side_validations = s + + @classmethod + def set_default(cls, default): + """Set default instance of configuration. + + It stores default configuration, which can be + returned by get_default_copy method. + + :param default: object of Configuration + """ + cls._default = copy.deepcopy(default) + + @classmethod + def get_default_copy(cls): + """Return new instance of configuration. + + This method returns newly created, based on default constructor, + object of Configuration class or returns a copy of default + configuration passed by the set_default method. + + :return: The configuration object. + """ + if cls._default is not None: + return copy.deepcopy(cls._default) + return Configuration() + + @property + def logger_file(self): + """The logger file. + + If the logger_file is None, then add stream handler and remove file + handler. Otherwise, add file handler and remove stream handler. + + :param value: The logger_file path. + :type: str + """ + return self.__logger_file + + @logger_file.setter + def logger_file(self, value): + """The logger file. + + If the logger_file is None, then add stream handler and remove file + handler. Otherwise, add file handler and remove stream handler. + + :param value: The logger_file path. + :type: str + """ + self.__logger_file = value + if self.__logger_file: + # If set logging file, + # then add file handler and remove stream handler. + self.logger_file_handler = logging.FileHandler(self.__logger_file) + self.logger_file_handler.setFormatter(self.logger_formatter) + for _, logger in self.logger.items(): + logger.addHandler(self.logger_file_handler) + + @property + def debug(self): + """Debug status + + :param value: The debug status, True or False. + :type: bool + """ + return self.__debug + + @debug.setter + def debug(self, value): + """Debug status + + :param value: The debug status, True or False. + :type: bool + """ + self.__debug = value + if self.__debug: + # if debug status is True, turn on debug logging + for _, logger in self.logger.items(): + logger.setLevel(logging.DEBUG) + # turn on http_client debug + http_client.HTTPConnection.debuglevel = 1 + else: + # if debug status is False, turn off debug logging, + # setting log level to default `logging.WARNING` + for _, logger in self.logger.items(): + logger.setLevel(logging.WARNING) + # turn off http_client debug + http_client.HTTPConnection.debuglevel = 0 + + @property + def logger_format(self): + """The logger format. + + The logger_formatter will be updated when sets logger_format. + + :param value: The format string. + :type: str + """ + return self.__logger_format + + @logger_format.setter + def logger_format(self, value): + """The logger format. + + The logger_formatter will be updated when sets logger_format. + + :param value: The format string. + :type: str + """ + self.__logger_format = value + self.logger_formatter = logging.Formatter(self.__logger_format) + + def get_api_key_with_prefix(self, identifier, alias=None): + """Gets API key (with prefix if set). + + :param identifier: The identifier of apiKey. + :param alias: The alternative identifier of apiKey. + :return: The token for api key authentication. + """ + if self.refresh_api_key_hook is not None: + self.refresh_api_key_hook(self) + key = self.api_key.get(identifier, self.api_key.get(alias) if alias is not None else None) + if key: + prefix = self.api_key_prefix.get(identifier) + if prefix: + return "%s %s" % (prefix, key) + else: + return key + + def get_basic_auth_token(self): + """Gets HTTP basic authentication header (string). + + :return: The token for basic HTTP authentication. + """ + username = "" + if self.username is not None: + username = self.username + password = "" + if self.password is not None: + password = self.password + return urllib3.util.make_headers( + basic_auth=username + ':' + password + ).get('authorization') + + def auth_settings(self): + """Gets Auth Settings dict for api client. + + :return: The Auth Settings information dict. + """ + auth = {} + if 'apiKey' in self.api_key: + auth['apiKey'] = { + 'type': 'api_key', + 'in': 'header', + 'key': 'Authorization', + 'value': self.get_api_key_with_prefix( + 'apiKey', + ), + } + if 'applicationId' in self.api_key: + auth['applicationId'] = { + 'type': 'api_key', + 'in': 'header', + 'key': 'x-apideck-app-id', + 'value': self.get_api_key_with_prefix( + 'applicationId', + ), + } + if 'consumerId' in self.api_key: + auth['consumerId'] = { + 'type': 'api_key', + 'in': 'header', + 'key': 'x-apideck-consumer-id', + 'value': self.get_api_key_with_prefix( + 'consumerId', + ), + } + return auth + + def to_debug_report(self): + """Gets the essential information for debugging. + + :return: The report for debugging. + """ + return "Python SDK Debug Report:\n"\ + "OS: {env}\n"\ + "Python Version: {pyversion}\n"\ + "Version of the API: 8.85.0\n"\ + "SDK Package Version: 0.0.1".\ + format(env=sys.platform, pyversion=sys.version) + + def get_host_settings(self): + """Gets an array of host settings + + :return: An array of host settings + """ + return [ + { + 'url': "https://unify.apideck.com", + 'description': "No description provided", + } + ] + + def get_host_from_settings(self, index, variables=None, servers=None): + """Gets host URL based on the index and variables + :param index: array index of the host settings + :param variables: hash of variable and the corresponding value + :param servers: an array of host settings or None + :return: URL based on host settings + """ + if index is None: + return self._base_path + + variables = {} if variables is None else variables + servers = self.get_host_settings() if servers is None else servers + + try: + server = servers[index] + except IndexError: + raise ValueError( + "Invalid index {0} when selecting the host settings. " + "Must be less than {1}".format(index, len(servers))) + + url = server['url'] + + # go through variables and replace placeholders + for variable_name, variable in server.get('variables', {}).items(): + used_value = variables.get( + variable_name, variable['default_value']) + + if 'enum_values' in variable \ + and used_value not in variable['enum_values']: + raise ValueError( + "The variable `{0}` in the host URL has invalid value " + "{1}. Must be {2}.".format( + variable_name, variables[variable_name], + variable['enum_values'])) + + url = url.replace("{" + variable_name + "}", used_value) + + return url + + @property + def host(self): + """Return generated host.""" + return self.get_host_from_settings(self.server_index, variables=self.server_variables) + + @host.setter + def host(self, value): + """Fix base path.""" + self._base_path = value + self.server_index = None diff --git a/src/apideck/exceptions.py b/src/apideck/exceptions.py new file mode 100644 index 0000000000..33a4a72264 --- /dev/null +++ b/src/apideck/exceptions.py @@ -0,0 +1,159 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + + +class OpenApiException(Exception): + """The base exception class for all OpenAPIExceptions""" + + +class ApiTypeError(OpenApiException, TypeError): + def __init__(self, msg, path_to_item=None, valid_classes=None, + key_type=None): + """ Raises an exception for TypeErrors + + Args: + msg (str): the exception message + + Keyword Args: + path_to_item (list): a list of keys an indices to get to the + current_item + None if unset + valid_classes (tuple): the primitive classes that current item + should be an instance of + None if unset + key_type (bool): False if our value is a value in a dict + True if it is a key in a dict + False if our item is an item in a list + None if unset + """ + self.path_to_item = path_to_item + self.valid_classes = valid_classes + self.key_type = key_type + full_msg = msg + if path_to_item: + full_msg = "{0} at {1}".format(msg, render_path(path_to_item)) + super(ApiTypeError, self).__init__(full_msg) + + +class ApiValueError(OpenApiException, ValueError): + def __init__(self, msg, path_to_item=None): + """ + Args: + msg (str): the exception message + + Keyword Args: + path_to_item (list) the path to the exception in the + received_data dict. None if unset + """ + + self.path_to_item = path_to_item + full_msg = msg + if path_to_item: + full_msg = "{0} at {1}".format(msg, render_path(path_to_item)) + super(ApiValueError, self).__init__(full_msg) + + +class ApiAttributeError(OpenApiException, AttributeError): + def __init__(self, msg, path_to_item=None): + """ + Raised when an attribute reference or assignment fails. + + Args: + msg (str): the exception message + + Keyword Args: + path_to_item (None/list) the path to the exception in the + received_data dict + """ + self.path_to_item = path_to_item + full_msg = msg + if path_to_item: + full_msg = "{0} at {1}".format(msg, render_path(path_to_item)) + super(ApiAttributeError, self).__init__(full_msg) + + +class ApiKeyError(OpenApiException, KeyError): + def __init__(self, msg, path_to_item=None): + """ + Args: + msg (str): the exception message + + Keyword Args: + path_to_item (None/list) the path to the exception in the + received_data dict + """ + self.path_to_item = path_to_item + full_msg = msg + if path_to_item: + full_msg = "{0} at {1}".format(msg, render_path(path_to_item)) + super(ApiKeyError, self).__init__(full_msg) + + +class ApiException(OpenApiException): + + def __init__(self, status=None, reason=None, http_resp=None): + if http_resp: + self.status = http_resp.status + self.reason = http_resp.reason + self.body = http_resp.data + self.headers = http_resp.getheaders() + else: + self.status = status + self.reason = reason + self.body = None + self.headers = None + + def __str__(self): + """Custom error messages for exception""" + error_message = "({0})\n"\ + "Reason: {1}\n".format(self.status, self.reason) + if self.headers: + error_message += "HTTP response headers: {0}\n".format( + self.headers) + + if self.body: + error_message += "HTTP response body: {0}\n".format(self.body) + + return error_message + + +class NotFoundException(ApiException): + + def __init__(self, status=None, reason=None, http_resp=None): + super(NotFoundException, self).__init__(status, reason, http_resp) + + +class UnauthorizedException(ApiException): + + def __init__(self, status=None, reason=None, http_resp=None): + super(UnauthorizedException, self).__init__(status, reason, http_resp) + + +class ForbiddenException(ApiException): + + def __init__(self, status=None, reason=None, http_resp=None): + super(ForbiddenException, self).__init__(status, reason, http_resp) + + +class ServiceException(ApiException): + + def __init__(self, status=None, reason=None, http_resp=None): + super(ServiceException, self).__init__(status, reason, http_resp) + + +def render_path(path_to_item): + """Returns a string representation of a path""" + result = "" + for pth in path_to_item: + if isinstance(pth, int): + result += "[{0}]".format(pth) + else: + result += "['{0}']".format(pth) + return result diff --git a/src/apideck/model/__init__.py b/src/apideck/model/__init__.py new file mode 100644 index 0000000000..cfe32b7849 --- /dev/null +++ b/src/apideck/model/__init__.py @@ -0,0 +1,5 @@ +# we can not import model classes here because that would create a circular +# reference which would not work in python2 +# do not import all models into this module because that uses a lot of memory and stack frames +# if you need the ability to import all models from one package, import them with +# from {{packageName}.models import ModelA, ModelB diff --git a/src/apideck/model/accounting_customer.py b/src/apideck/model/accounting_customer.py new file mode 100644 index 0000000000..cb93f6244d --- /dev/null +++ b/src/apideck/model/accounting_customer.py @@ -0,0 +1,382 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.address import Address + from apideck.model.bank_account import BankAccount + from apideck.model.currency import Currency + from apideck.model.email import Email + from apideck.model.linked_tax_rate import LinkedTaxRate + from apideck.model.phone_number import PhoneNumber + from apideck.model.website import Website + globals()['Address'] = Address + globals()['BankAccount'] = BankAccount + globals()['Currency'] = Currency + globals()['Email'] = Email + globals()['LinkedTaxRate'] = LinkedTaxRate + globals()['PhoneNumber'] = PhoneNumber + globals()['Website'] = Website + + +class AccountingCustomer(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('status',): { + 'None': None, + 'ACTIVE': "active", + 'INACTIVE': "inactive", + 'ARCHIVED': "archived", + 'GDPR-ERASURE-REQUEST': "gdpr-erasure-request", + 'UNKNOWN': "unknown", + }, + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'id': (str,), # noqa: E501 + 'display_id': (str, none_type,), # noqa: E501 + 'display_name': (str, none_type,), # noqa: E501 + 'company_name': (str, none_type,), # noqa: E501 + 'title': (str, none_type,), # noqa: E501 + 'first_name': (str, none_type,), # noqa: E501 + 'middle_name': (str, none_type,), # noqa: E501 + 'last_name': (str, none_type,), # noqa: E501 + 'suffix': (str, none_type,), # noqa: E501 + 'individual': (bool, none_type,), # noqa: E501 + 'addresses': ([Address],), # noqa: E501 + 'notes': (str, none_type,), # noqa: E501 + 'phone_numbers': ([PhoneNumber],), # noqa: E501 + 'emails': ([Email],), # noqa: E501 + 'websites': ([Website],), # noqa: E501 + 'tax_rate': (LinkedTaxRate,), # noqa: E501 + 'tax_number': (str, none_type,), # noqa: E501 + 'currency': (Currency,), # noqa: E501 + 'bank_accounts': ([BankAccount],), # noqa: E501 + 'status': (str, none_type,), # noqa: E501 + 'row_version': (str, none_type,), # noqa: E501 + 'updated_by': (str, none_type,), # noqa: E501 + 'created_by': (str, none_type,), # noqa: E501 + 'updated_at': (datetime,), # noqa: E501 + 'created_at': (datetime,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'display_id': 'display_id', # noqa: E501 + 'display_name': 'display_name', # noqa: E501 + 'company_name': 'company_name', # noqa: E501 + 'title': 'title', # noqa: E501 + 'first_name': 'first_name', # noqa: E501 + 'middle_name': 'middle_name', # noqa: E501 + 'last_name': 'last_name', # noqa: E501 + 'suffix': 'suffix', # noqa: E501 + 'individual': 'individual', # noqa: E501 + 'addresses': 'addresses', # noqa: E501 + 'notes': 'notes', # noqa: E501 + 'phone_numbers': 'phone_numbers', # noqa: E501 + 'emails': 'emails', # noqa: E501 + 'websites': 'websites', # noqa: E501 + 'tax_rate': 'tax_rate', # noqa: E501 + 'tax_number': 'tax_number', # noqa: E501 + 'currency': 'currency', # noqa: E501 + 'bank_accounts': 'bank_accounts', # noqa: E501 + 'status': 'status', # noqa: E501 + 'row_version': 'row_version', # noqa: E501 + 'updated_by': 'updated_by', # noqa: E501 + 'created_by': 'created_by', # noqa: E501 + 'updated_at': 'updated_at', # noqa: E501 + 'created_at': 'created_at', # noqa: E501 + } + + read_only_vars = { + 'id', # noqa: E501 + 'updated_by', # noqa: E501 + 'created_by', # noqa: E501 + 'updated_at', # noqa: E501 + 'created_at', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """AccountingCustomer - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + display_id (str, none_type): Display ID. [optional] # noqa: E501 + display_name (str, none_type): Display Name. [optional] # noqa: E501 + company_name (str, none_type): [optional] # noqa: E501 + title (str, none_type): [optional] # noqa: E501 + first_name (str, none_type): [optional] # noqa: E501 + middle_name (str, none_type): [optional] # noqa: E501 + last_name (str, none_type): [optional] # noqa: E501 + suffix (str, none_type): [optional] # noqa: E501 + individual (bool, none_type): Is this an individual or business customer. [optional] # noqa: E501 + addresses ([Address]): [optional] # noqa: E501 + notes (str, none_type): Some notes about this customer. [optional] # noqa: E501 + phone_numbers ([PhoneNumber]): [optional] # noqa: E501 + emails ([Email]): [optional] # noqa: E501 + websites ([Website]): [optional] # noqa: E501 + tax_rate (LinkedTaxRate): [optional] # noqa: E501 + tax_number (str, none_type): [optional] # noqa: E501 + currency (Currency): [optional] # noqa: E501 + bank_accounts ([BankAccount]): [optional] # noqa: E501 + status (str, none_type): Customer status. [optional] # noqa: E501 + row_version (str, none_type): [optional] # noqa: E501 + updated_by (str, none_type): [optional] # noqa: E501 + created_by (str, none_type): [optional] # noqa: E501 + updated_at (datetime): [optional] # noqa: E501 + created_at (datetime): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """AccountingCustomer - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + display_id (str, none_type): Display ID. [optional] # noqa: E501 + display_name (str, none_type): Display Name. [optional] # noqa: E501 + company_name (str, none_type): [optional] # noqa: E501 + title (str, none_type): [optional] # noqa: E501 + first_name (str, none_type): [optional] # noqa: E501 + middle_name (str, none_type): [optional] # noqa: E501 + last_name (str, none_type): [optional] # noqa: E501 + suffix (str, none_type): [optional] # noqa: E501 + individual (bool, none_type): Is this an individual or business customer. [optional] # noqa: E501 + addresses ([Address]): [optional] # noqa: E501 + notes (str, none_type): Some notes about this customer. [optional] # noqa: E501 + phone_numbers ([PhoneNumber]): [optional] # noqa: E501 + emails ([Email]): [optional] # noqa: E501 + websites ([Website]): [optional] # noqa: E501 + tax_rate (LinkedTaxRate): [optional] # noqa: E501 + tax_number (str, none_type): [optional] # noqa: E501 + currency (Currency): [optional] # noqa: E501 + bank_accounts ([BankAccount]): [optional] # noqa: E501 + status (str, none_type): Customer status. [optional] # noqa: E501 + row_version (str, none_type): [optional] # noqa: E501 + updated_by (str, none_type): [optional] # noqa: E501 + created_by (str, none_type): [optional] # noqa: E501 + updated_at (datetime): [optional] # noqa: E501 + created_at (datetime): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/accounting_event_type.py b/src/apideck/model/accounting_event_type.py new file mode 100644 index 0000000000..ea552c2105 --- /dev/null +++ b/src/apideck/model/accounting_event_type.py @@ -0,0 +1,305 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class AccountingEventType(ModelSimple): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('value',): { + '*': "*", + 'ACCOUNTING.CUSTOMER.CREATED': "accounting.customer.created", + 'ACCOUNTING.CUSTOMER.UPDATED': "accounting.customer.updated", + 'ACCOUNTING.CUSTOMER.DELETED': "accounting.customer.deleted", + 'ACCOUNTING.INVOICE.CREATED': "accounting.invoice.created", + 'ACCOUNTING.INVOICE.UPDATED': "accounting.invoice.updated", + 'ACCOUNTING.INVOICE.DELETED': "accounting.invoice.deleted", + 'ACCOUNTING.INVOICE_ITEM.CREATED': "accounting.invoice_item.created", + 'ACCOUNTING.INVOICE_ITEM.UPDATED': "accounting.invoice_item.updated", + 'ACCOUNTING.INVOICE_ITEM.DELETED': "accounting.invoice_item.deleted", + 'ACCOUNTING.LEDGER_ACCOUNT.CREATED': "accounting.ledger_account.created", + 'ACCOUNTING.LEDGER_ACCOUNT.UPDATED': "accounting.ledger_account.updated", + 'ACCOUNTING.LEDGER_ACCOUNT.DELETED': "accounting.ledger_account.deleted", + 'ACCOUNTING.TAX_RATE.CREATED': "accounting.tax_rate.created", + 'ACCOUNTING.TAX_RATE.UPDATED': "accounting.tax_rate.updated", + 'ACCOUNTING.TAX_RATE.DELETED': "accounting.tax_rate.deleted", + 'ACCOUNTING.BILL.CREATED': "accounting.bill.created", + 'ACCOUNTING.BILL.UPDATED': "accounting.bill.updated", + 'ACCOUNTING.BILL.DELETED': "accounting.bill.deleted", + 'ACCOUNTING.PAYMENT.CREATED': "accounting.payment.created", + 'ACCOUNTING.PAYMENT.UPDATED': "accounting.payment.updated", + 'ACCOUNTING.PAYMENT.DELETED': "accounting.payment.deleted", + 'ACCOUNTING.SUPPLIER.CREATED': "accounting.supplier.created", + 'ACCOUNTING.SUPPLIER.UPDATED': "accounting.supplier.updated", + 'ACCOUNTING.SUPPLIER.DELETED': "accounting.supplier.deleted", + }, + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'value': (str,), + } + + @cached_property + def discriminator(): + return None + + + attribute_map = {} + + read_only_vars = set() + + _composed_schemas = None + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): + """AccountingEventType - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] (str):, must be one of ["*", "accounting.customer.created", "accounting.customer.updated", "accounting.customer.deleted", "accounting.invoice.created", "accounting.invoice.updated", "accounting.invoice.deleted", "accounting.invoice_item.created", "accounting.invoice_item.updated", "accounting.invoice_item.deleted", "accounting.ledger_account.created", "accounting.ledger_account.updated", "accounting.ledger_account.deleted", "accounting.tax_rate.created", "accounting.tax_rate.updated", "accounting.tax_rate.deleted", "accounting.bill.created", "accounting.bill.updated", "accounting.bill.deleted", "accounting.payment.created", "accounting.payment.updated", "accounting.payment.deleted", "accounting.supplier.created", "accounting.supplier.updated", "accounting.supplier.deleted", ] # noqa: E501 + + Keyword Args: + value (str):, must be one of ["*", "accounting.customer.created", "accounting.customer.updated", "accounting.customer.deleted", "accounting.invoice.created", "accounting.invoice.updated", "accounting.invoice.deleted", "accounting.invoice_item.created", "accounting.invoice_item.updated", "accounting.invoice_item.deleted", "accounting.ledger_account.created", "accounting.ledger_account.updated", "accounting.ledger_account.deleted", "accounting.tax_rate.created", "accounting.tax_rate.updated", "accounting.tax_rate.deleted", "accounting.bill.created", "accounting.bill.updated", "accounting.bill.deleted", "accounting.payment.created", "accounting.payment.updated", "accounting.payment.deleted", "accounting.supplier.created", "accounting.supplier.updated", "accounting.supplier.deleted", ] # noqa: E501 + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + self.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): + """AccountingEventType - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] (str):, must be one of ["*", "accounting.customer.created", "accounting.customer.updated", "accounting.customer.deleted", "accounting.invoice.created", "accounting.invoice.updated", "accounting.invoice.deleted", "accounting.invoice_item.created", "accounting.invoice_item.updated", "accounting.invoice_item.deleted", "accounting.ledger_account.created", "accounting.ledger_account.updated", "accounting.ledger_account.deleted", "accounting.tax_rate.created", "accounting.tax_rate.updated", "accounting.tax_rate.deleted", "accounting.bill.created", "accounting.bill.updated", "accounting.bill.deleted", "accounting.payment.created", "accounting.payment.updated", "accounting.payment.deleted", "accounting.supplier.created", "accounting.supplier.updated", "accounting.supplier.deleted", ] # noqa: E501 + + Keyword Args: + value (str):, must be one of ["*", "accounting.customer.created", "accounting.customer.updated", "accounting.customer.deleted", "accounting.invoice.created", "accounting.invoice.updated", "accounting.invoice.deleted", "accounting.invoice_item.created", "accounting.invoice_item.updated", "accounting.invoice_item.deleted", "accounting.ledger_account.created", "accounting.ledger_account.updated", "accounting.ledger_account.deleted", "accounting.tax_rate.created", "accounting.tax_rate.updated", "accounting.tax_rate.deleted", "accounting.bill.created", "accounting.bill.updated", "accounting.bill.deleted", "accounting.payment.created", "accounting.payment.updated", "accounting.payment.deleted", "accounting.supplier.created", "accounting.supplier.updated", "accounting.supplier.deleted", ] # noqa: E501 + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + self.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + return self diff --git a/src/apideck/model/activity.py b/src/apideck/model/activity.py new file mode 100644 index 0000000000..dbc1aa0f6d --- /dev/null +++ b/src/apideck/model/activity.py @@ -0,0 +1,485 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.activity_attendee import ActivityAttendee + from apideck.model.address import Address + from apideck.model.custom_field import CustomField + globals()['ActivityAttendee'] = ActivityAttendee + globals()['Address'] = Address + globals()['CustomField'] = CustomField + + +class Activity(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('type',): { + 'CALL': "call", + 'MEETING': "meeting", + 'EMAIL': "email", + 'NOTE': "note", + 'TASK': "task", + 'DEADLINE': "deadline", + 'SEND-LETTER': "send-letter", + 'SEND-QUOTE': "send-quote", + 'OTHER': "other", + }, + ('show_as',): { + 'FREE': "free", + 'BUSY': "busy", + }, + } + + validations = { + ('duration_seconds',): { + 'inclusive_minimum': 0, + }, + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'type': (str,), # noqa: E501 + 'id': (str,), # noqa: E501 + 'downstream_id': (str, none_type,), # noqa: E501 + 'activity_datetime': (str, none_type,), # noqa: E501 + 'duration_seconds': (int, none_type,), # noqa: E501 + 'user_id': (str, none_type,), # noqa: E501 + 'account_id': (str, none_type,), # noqa: E501 + 'contact_id': (str, none_type,), # noqa: E501 + 'company_id': (str, none_type,), # noqa: E501 + 'opportunity_id': (str, none_type,), # noqa: E501 + 'lead_id': (str, none_type,), # noqa: E501 + 'owner_id': (str, none_type,), # noqa: E501 + 'campaign_id': (str, none_type,), # noqa: E501 + 'case_id': (str, none_type,), # noqa: E501 + 'asset_id': (str, none_type,), # noqa: E501 + 'contract_id': (str, none_type,), # noqa: E501 + 'product_id': (str, none_type,), # noqa: E501 + 'solution_id': (str, none_type,), # noqa: E501 + 'custom_object_id': (str, none_type,), # noqa: E501 + 'title': (str, none_type,), # noqa: E501 + 'description': (str, none_type,), # noqa: E501 + 'note': (str, none_type,), # noqa: E501 + 'location': (str, none_type,), # noqa: E501 + 'location_address': (Address,), # noqa: E501 + 'all_day_event': (bool,), # noqa: E501 + 'private': (bool,), # noqa: E501 + 'group_event': (bool,), # noqa: E501 + 'event_sub_type': (str, none_type,), # noqa: E501 + 'group_event_type': (str, none_type,), # noqa: E501 + 'child': (bool,), # noqa: E501 + 'archived': (bool,), # noqa: E501 + 'deleted': (bool,), # noqa: E501 + 'show_as': (str,), # noqa: E501 + 'done': (bool,), # noqa: E501 + 'start_datetime': (str, none_type,), # noqa: E501 + 'end_datetime': (str, none_type,), # noqa: E501 + 'duration_minutes': (int, none_type,), # noqa: E501 + 'activity_date': (str, none_type,), # noqa: E501 + 'end_date': (str, none_type,), # noqa: E501 + 'recurrent': (bool,), # noqa: E501 + 'reminder_datetime': (str, none_type,), # noqa: E501 + 'reminder_set': (bool, none_type,), # noqa: E501 + 'video_conference_url': (str,), # noqa: E501 + 'video_conference_id': (str,), # noqa: E501 + 'custom_fields': ([CustomField],), # noqa: E501 + 'attendees': ([ActivityAttendee],), # noqa: E501 + 'updated_by': (str, none_type,), # noqa: E501 + 'created_by': (str, none_type,), # noqa: E501 + 'updated_at': (str,), # noqa: E501 + 'created_at': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'type': 'type', # noqa: E501 + 'id': 'id', # noqa: E501 + 'downstream_id': 'downstream_id', # noqa: E501 + 'activity_datetime': 'activity_datetime', # noqa: E501 + 'duration_seconds': 'duration_seconds', # noqa: E501 + 'user_id': 'user_id', # noqa: E501 + 'account_id': 'account_id', # noqa: E501 + 'contact_id': 'contact_id', # noqa: E501 + 'company_id': 'company_id', # noqa: E501 + 'opportunity_id': 'opportunity_id', # noqa: E501 + 'lead_id': 'lead_id', # noqa: E501 + 'owner_id': 'owner_id', # noqa: E501 + 'campaign_id': 'campaign_id', # noqa: E501 + 'case_id': 'case_id', # noqa: E501 + 'asset_id': 'asset_id', # noqa: E501 + 'contract_id': 'contract_id', # noqa: E501 + 'product_id': 'product_id', # noqa: E501 + 'solution_id': 'solution_id', # noqa: E501 + 'custom_object_id': 'custom_object_id', # noqa: E501 + 'title': 'title', # noqa: E501 + 'description': 'description', # noqa: E501 + 'note': 'note', # noqa: E501 + 'location': 'location', # noqa: E501 + 'location_address': 'location_address', # noqa: E501 + 'all_day_event': 'all_day_event', # noqa: E501 + 'private': 'private', # noqa: E501 + 'group_event': 'group_event', # noqa: E501 + 'event_sub_type': 'event_sub_type', # noqa: E501 + 'group_event_type': 'group_event_type', # noqa: E501 + 'child': 'child', # noqa: E501 + 'archived': 'archived', # noqa: E501 + 'deleted': 'deleted', # noqa: E501 + 'show_as': 'show_as', # noqa: E501 + 'done': 'done', # noqa: E501 + 'start_datetime': 'start_datetime', # noqa: E501 + 'end_datetime': 'end_datetime', # noqa: E501 + 'duration_minutes': 'duration_minutes', # noqa: E501 + 'activity_date': 'activity_date', # noqa: E501 + 'end_date': 'end_date', # noqa: E501 + 'recurrent': 'recurrent', # noqa: E501 + 'reminder_datetime': 'reminder_datetime', # noqa: E501 + 'reminder_set': 'reminder_set', # noqa: E501 + 'video_conference_url': 'video_conference_url', # noqa: E501 + 'video_conference_id': 'video_conference_id', # noqa: E501 + 'custom_fields': 'custom_fields', # noqa: E501 + 'attendees': 'attendees', # noqa: E501 + 'updated_by': 'updated_by', # noqa: E501 + 'created_by': 'created_by', # noqa: E501 + 'updated_at': 'updated_at', # noqa: E501 + 'created_at': 'created_at', # noqa: E501 + } + + read_only_vars = { + 'id', # noqa: E501 + 'downstream_id', # noqa: E501 + 'duration_minutes', # noqa: E501 + 'updated_by', # noqa: E501 + 'created_by', # noqa: E501 + 'updated_at', # noqa: E501 + 'created_at', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, type, *args, **kwargs): # noqa: E501 + """Activity - a model defined in OpenAPI + + Args: + type (str): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + downstream_id (str, none_type): The third-party API ID of original entity. [optional] # noqa: E501 + activity_datetime (str, none_type): [optional] # noqa: E501 + duration_seconds (int, none_type): [optional] # noqa: E501 + user_id (str, none_type): [optional] # noqa: E501 + account_id (str, none_type): [optional] # noqa: E501 + contact_id (str, none_type): [optional] # noqa: E501 + company_id (str, none_type): [optional] # noqa: E501 + opportunity_id (str, none_type): [optional] # noqa: E501 + lead_id (str, none_type): [optional] # noqa: E501 + owner_id (str, none_type): [optional] # noqa: E501 + campaign_id (str, none_type): [optional] # noqa: E501 + case_id (str, none_type): [optional] # noqa: E501 + asset_id (str, none_type): [optional] # noqa: E501 + contract_id (str, none_type): [optional] # noqa: E501 + product_id (str, none_type): [optional] # noqa: E501 + solution_id (str, none_type): [optional] # noqa: E501 + custom_object_id (str, none_type): [optional] # noqa: E501 + title (str, none_type): [optional] # noqa: E501 + description (str, none_type): [optional] # noqa: E501 + note (str, none_type): [optional] # noqa: E501 + location (str, none_type): [optional] # noqa: E501 + location_address (Address): [optional] # noqa: E501 + all_day_event (bool): [optional] # noqa: E501 + private (bool): [optional] # noqa: E501 + group_event (bool): [optional] # noqa: E501 + event_sub_type (str, none_type): [optional] # noqa: E501 + group_event_type (str, none_type): [optional] # noqa: E501 + child (bool): [optional] # noqa: E501 + archived (bool): [optional] # noqa: E501 + deleted (bool): [optional] # noqa: E501 + show_as (str): [optional] # noqa: E501 + done (bool): Whether the Activity is done or not. [optional] # noqa: E501 + start_datetime (str, none_type): [optional] # noqa: E501 + end_datetime (str, none_type): [optional] # noqa: E501 + duration_minutes (int, none_type): [optional] # noqa: E501 + activity_date (str, none_type): [optional] # noqa: E501 + end_date (str, none_type): [optional] # noqa: E501 + recurrent (bool): [optional] # noqa: E501 + reminder_datetime (str, none_type): [optional] # noqa: E501 + reminder_set (bool, none_type): [optional] # noqa: E501 + video_conference_url (str): [optional] # noqa: E501 + video_conference_id (str): [optional] # noqa: E501 + custom_fields ([CustomField]): [optional] # noqa: E501 + attendees ([ActivityAttendee]): [optional] # noqa: E501 + updated_by (str, none_type): [optional] # noqa: E501 + created_by (str, none_type): [optional] # noqa: E501 + updated_at (str): [optional] # noqa: E501 + created_at (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.type = type + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, type, *args, **kwargs): # noqa: E501 + """Activity - a model defined in OpenAPI + + Args: + type (str): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + downstream_id (str, none_type): The third-party API ID of original entity. [optional] # noqa: E501 + activity_datetime (str, none_type): [optional] # noqa: E501 + duration_seconds (int, none_type): [optional] # noqa: E501 + user_id (str, none_type): [optional] # noqa: E501 + account_id (str, none_type): [optional] # noqa: E501 + contact_id (str, none_type): [optional] # noqa: E501 + company_id (str, none_type): [optional] # noqa: E501 + opportunity_id (str, none_type): [optional] # noqa: E501 + lead_id (str, none_type): [optional] # noqa: E501 + owner_id (str, none_type): [optional] # noqa: E501 + campaign_id (str, none_type): [optional] # noqa: E501 + case_id (str, none_type): [optional] # noqa: E501 + asset_id (str, none_type): [optional] # noqa: E501 + contract_id (str, none_type): [optional] # noqa: E501 + product_id (str, none_type): [optional] # noqa: E501 + solution_id (str, none_type): [optional] # noqa: E501 + custom_object_id (str, none_type): [optional] # noqa: E501 + title (str, none_type): [optional] # noqa: E501 + description (str, none_type): [optional] # noqa: E501 + note (str, none_type): [optional] # noqa: E501 + location (str, none_type): [optional] # noqa: E501 + location_address (Address): [optional] # noqa: E501 + all_day_event (bool): [optional] # noqa: E501 + private (bool): [optional] # noqa: E501 + group_event (bool): [optional] # noqa: E501 + event_sub_type (str, none_type): [optional] # noqa: E501 + group_event_type (str, none_type): [optional] # noqa: E501 + child (bool): [optional] # noqa: E501 + archived (bool): [optional] # noqa: E501 + deleted (bool): [optional] # noqa: E501 + show_as (str): [optional] # noqa: E501 + done (bool): Whether the Activity is done or not. [optional] # noqa: E501 + start_datetime (str, none_type): [optional] # noqa: E501 + end_datetime (str, none_type): [optional] # noqa: E501 + duration_minutes (int, none_type): [optional] # noqa: E501 + activity_date (str, none_type): [optional] # noqa: E501 + end_date (str, none_type): [optional] # noqa: E501 + recurrent (bool): [optional] # noqa: E501 + reminder_datetime (str, none_type): [optional] # noqa: E501 + reminder_set (bool, none_type): [optional] # noqa: E501 + video_conference_url (str): [optional] # noqa: E501 + video_conference_id (str): [optional] # noqa: E501 + custom_fields ([CustomField]): [optional] # noqa: E501 + attendees ([ActivityAttendee]): [optional] # noqa: E501 + updated_by (str, none_type): [optional] # noqa: E501 + created_by (str, none_type): [optional] # noqa: E501 + updated_at (str): [optional] # noqa: E501 + created_at (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.type = type + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/activity_attendee.py b/src/apideck/model/activity_attendee.py new file mode 100644 index 0000000000..7fe3c24caf --- /dev/null +++ b/src/apideck/model/activity_attendee.py @@ -0,0 +1,315 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class ActivityAttendee(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('status',): { + 'None': None, + 'ACCEPTED': "accepted", + 'TENTATIVE': "tentative", + 'DECLINED': "declined", + }, + } + + validations = { + ('name',): { + 'min_length': 1, + }, + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'id': (str,), # noqa: E501 + 'name': (str,), # noqa: E501 + 'first_name': (str, none_type,), # noqa: E501 + 'middle_name': (str, none_type,), # noqa: E501 + 'last_name': (str, none_type,), # noqa: E501 + 'prefix': (str, none_type,), # noqa: E501 + 'suffix': (str, none_type,), # noqa: E501 + 'email_address': (str, none_type,), # noqa: E501 + 'is_organizer': (bool, none_type,), # noqa: E501 + 'status': (str, none_type,), # noqa: E501 + 'user_id': (str,), # noqa: E501 + 'contact_id': (str,), # noqa: E501 + 'updated_at': (datetime,), # noqa: E501 + 'created_at': (datetime,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'name': 'name', # noqa: E501 + 'first_name': 'first_name', # noqa: E501 + 'middle_name': 'middle_name', # noqa: E501 + 'last_name': 'last_name', # noqa: E501 + 'prefix': 'prefix', # noqa: E501 + 'suffix': 'suffix', # noqa: E501 + 'email_address': 'email_address', # noqa: E501 + 'is_organizer': 'is_organizer', # noqa: E501 + 'status': 'status', # noqa: E501 + 'user_id': 'user_id', # noqa: E501 + 'contact_id': 'contact_id', # noqa: E501 + 'updated_at': 'updated_at', # noqa: E501 + 'created_at': 'created_at', # noqa: E501 + } + + read_only_vars = { + 'id', # noqa: E501 + 'user_id', # noqa: E501 + 'contact_id', # noqa: E501 + 'updated_at', # noqa: E501 + 'created_at', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ActivityAttendee - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + name (str): [optional] # noqa: E501 + first_name (str, none_type): [optional] # noqa: E501 + middle_name (str, none_type): [optional] # noqa: E501 + last_name (str, none_type): [optional] # noqa: E501 + prefix (str, none_type): [optional] # noqa: E501 + suffix (str, none_type): [optional] # noqa: E501 + email_address (str, none_type): [optional] # noqa: E501 + is_organizer (bool, none_type): [optional] # noqa: E501 + status (str, none_type): [optional] # noqa: E501 + user_id (str): [optional] # noqa: E501 + contact_id (str): [optional] # noqa: E501 + updated_at (datetime): [optional] # noqa: E501 + created_at (datetime): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """ActivityAttendee - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + name (str): [optional] # noqa: E501 + first_name (str, none_type): [optional] # noqa: E501 + middle_name (str, none_type): [optional] # noqa: E501 + last_name (str, none_type): [optional] # noqa: E501 + prefix (str, none_type): [optional] # noqa: E501 + suffix (str, none_type): [optional] # noqa: E501 + email_address (str, none_type): [optional] # noqa: E501 + is_organizer (bool, none_type): [optional] # noqa: E501 + status (str, none_type): [optional] # noqa: E501 + user_id (str): [optional] # noqa: E501 + contact_id (str): [optional] # noqa: E501 + updated_at (datetime): [optional] # noqa: E501 + created_at (datetime): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/address.py b/src/apideck/model/address.py new file mode 100644 index 0000000000..238ccac9f1 --- /dev/null +++ b/src/apideck/model/address.py @@ -0,0 +1,346 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class Address(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('type',): { + 'PRIMARY': "primary", + 'SECONDARY': "secondary", + 'HOME': "home", + 'OFFICE': "office", + 'SHIPPING': "shipping", + 'BILLING': "billing", + 'OTHER': "other", + }, + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'id': (str, none_type,), # noqa: E501 + 'type': (str,), # noqa: E501 + 'string': (str, none_type,), # noqa: E501 + 'name': (str, none_type,), # noqa: E501 + 'line1': (str, none_type,), # noqa: E501 + 'line2': (str, none_type,), # noqa: E501 + 'line3': (str, none_type,), # noqa: E501 + 'line4': (str, none_type,), # noqa: E501 + 'street_number': (str, none_type,), # noqa: E501 + 'city': (str, none_type,), # noqa: E501 + 'state': (str, none_type,), # noqa: E501 + 'postal_code': (str, none_type,), # noqa: E501 + 'country': (str, none_type,), # noqa: E501 + 'latitude': (str, none_type,), # noqa: E501 + 'longitude': (str, none_type,), # noqa: E501 + 'county': (str, none_type,), # noqa: E501 + 'contact_name': (str, none_type,), # noqa: E501 + 'salutation': (str, none_type,), # noqa: E501 + 'phone_number': (str, none_type,), # noqa: E501 + 'fax': (str, none_type,), # noqa: E501 + 'email': (str, none_type,), # noqa: E501 + 'website': (str, none_type,), # noqa: E501 + 'row_version': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'type': 'type', # noqa: E501 + 'string': 'string', # noqa: E501 + 'name': 'name', # noqa: E501 + 'line1': 'line1', # noqa: E501 + 'line2': 'line2', # noqa: E501 + 'line3': 'line3', # noqa: E501 + 'line4': 'line4', # noqa: E501 + 'street_number': 'street_number', # noqa: E501 + 'city': 'city', # noqa: E501 + 'state': 'state', # noqa: E501 + 'postal_code': 'postal_code', # noqa: E501 + 'country': 'country', # noqa: E501 + 'latitude': 'latitude', # noqa: E501 + 'longitude': 'longitude', # noqa: E501 + 'county': 'county', # noqa: E501 + 'contact_name': 'contact_name', # noqa: E501 + 'salutation': 'salutation', # noqa: E501 + 'phone_number': 'phone_number', # noqa: E501 + 'fax': 'fax', # noqa: E501 + 'email': 'email', # noqa: E501 + 'website': 'website', # noqa: E501 + 'row_version': 'row_version', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """Address - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str, none_type): [optional] # noqa: E501 + type (str): [optional] # noqa: E501 + string (str, none_type): [optional] # noqa: E501 + name (str, none_type): [optional] # noqa: E501 + line1 (str, none_type): Line 1 of the address e.g. number, street, suite, apt #, etc.. [optional] # noqa: E501 + line2 (str, none_type): Line 2 of the address. [optional] # noqa: E501 + line3 (str, none_type): Line 3 of the address. [optional] # noqa: E501 + line4 (str, none_type): Line 4 of the address. [optional] # noqa: E501 + street_number (str, none_type): Street number. [optional] # noqa: E501 + city (str, none_type): Name of city.. [optional] # noqa: E501 + state (str, none_type): Name of state. [optional] # noqa: E501 + postal_code (str, none_type): Zip code or equivalent.. [optional] # noqa: E501 + country (str, none_type): country code according to ISO 3166-1 alpha-2.. [optional] # noqa: E501 + latitude (str, none_type): [optional] # noqa: E501 + longitude (str, none_type): [optional] # noqa: E501 + county (str, none_type): Address field that holds a sublocality, such as a county. [optional] # noqa: E501 + contact_name (str, none_type): [optional] # noqa: E501 + salutation (str, none_type): [optional] # noqa: E501 + phone_number (str, none_type): [optional] # noqa: E501 + fax (str, none_type): [optional] # noqa: E501 + email (str, none_type): [optional] # noqa: E501 + website (str, none_type): [optional] # noqa: E501 + row_version (str, none_type): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """Address - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str, none_type): [optional] # noqa: E501 + type (str): [optional] # noqa: E501 + string (str, none_type): [optional] # noqa: E501 + name (str, none_type): [optional] # noqa: E501 + line1 (str, none_type): Line 1 of the address e.g. number, street, suite, apt #, etc.. [optional] # noqa: E501 + line2 (str, none_type): Line 2 of the address. [optional] # noqa: E501 + line3 (str, none_type): Line 3 of the address. [optional] # noqa: E501 + line4 (str, none_type): Line 4 of the address. [optional] # noqa: E501 + street_number (str, none_type): Street number. [optional] # noqa: E501 + city (str, none_type): Name of city.. [optional] # noqa: E501 + state (str, none_type): Name of state. [optional] # noqa: E501 + postal_code (str, none_type): Zip code or equivalent.. [optional] # noqa: E501 + country (str, none_type): country code according to ISO 3166-1 alpha-2.. [optional] # noqa: E501 + latitude (str, none_type): [optional] # noqa: E501 + longitude (str, none_type): [optional] # noqa: E501 + county (str, none_type): Address field that holds a sublocality, such as a county. [optional] # noqa: E501 + contact_name (str, none_type): [optional] # noqa: E501 + salutation (str, none_type): [optional] # noqa: E501 + phone_number (str, none_type): [optional] # noqa: E501 + fax (str, none_type): [optional] # noqa: E501 + email (str, none_type): [optional] # noqa: E501 + website (str, none_type): [optional] # noqa: E501 + row_version (str, none_type): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/api.py b/src/apideck/model/api.py new file mode 100644 index 0000000000..345a83d82c --- /dev/null +++ b/src/apideck/model/api.py @@ -0,0 +1,308 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.api_resources import ApiResources + from apideck.model.api_status import ApiStatus + globals()['ApiResources'] = ApiResources + globals()['ApiStatus'] = ApiStatus + + +class Api(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('type',): { + 'PLATFORM': "platform", + 'UNIFIED': "unified", + }, + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'id': (str,), # noqa: E501 + 'type': (str,), # noqa: E501 + 'name': (str,), # noqa: E501 + 'description': (str, none_type,), # noqa: E501 + 'status': (ApiStatus,), # noqa: E501 + 'spec_url': (str,), # noqa: E501 + 'api_reference_url': (str,), # noqa: E501 + 'postman_collection_id': (str, none_type,), # noqa: E501 + 'categories': ([str],), # noqa: E501 + 'resources': ([ApiResources],), # noqa: E501 + 'events': ([str],), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'type': 'type', # noqa: E501 + 'name': 'name', # noqa: E501 + 'description': 'description', # noqa: E501 + 'status': 'status', # noqa: E501 + 'spec_url': 'spec_url', # noqa: E501 + 'api_reference_url': 'api_reference_url', # noqa: E501 + 'postman_collection_id': 'postman_collection_id', # noqa: E501 + 'categories': 'categories', # noqa: E501 + 'resources': 'resources', # noqa: E501 + 'events': 'events', # noqa: E501 + } + + read_only_vars = { + 'id', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """Api - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): ID of the API.. [optional] # noqa: E501 + type (str): Indicates whether the API is a Unified API. If unified_api is false, the API is a Platform API.. [optional] # noqa: E501 + name (str): Name of the API.. [optional] # noqa: E501 + description (str, none_type): Description of the API.. [optional] # noqa: E501 + status (ApiStatus): [optional] # noqa: E501 + spec_url (str): Link to the latest OpenAPI specification of the API.. [optional] # noqa: E501 + api_reference_url (str): Link to the API reference of the API.. [optional] # noqa: E501 + postman_collection_id (str, none_type): ID of the Postman collection of the API.. [optional] # noqa: E501 + categories ([str]): List of categories the API belongs to.. [optional] # noqa: E501 + resources ([ApiResources]): List of resources supported in this API.. [optional] # noqa: E501 + events ([str]): List of event types this API supports.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """Api - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): ID of the API.. [optional] # noqa: E501 + type (str): Indicates whether the API is a Unified API. If unified_api is false, the API is a Platform API.. [optional] # noqa: E501 + name (str): Name of the API.. [optional] # noqa: E501 + description (str, none_type): Description of the API.. [optional] # noqa: E501 + status (ApiStatus): [optional] # noqa: E501 + spec_url (str): Link to the latest OpenAPI specification of the API.. [optional] # noqa: E501 + api_reference_url (str): Link to the API reference of the API.. [optional] # noqa: E501 + postman_collection_id (str, none_type): ID of the Postman collection of the API.. [optional] # noqa: E501 + categories ([str]): List of categories the API belongs to.. [optional] # noqa: E501 + resources ([ApiResources]): List of resources supported in this API.. [optional] # noqa: E501 + events ([str]): List of event types this API supports.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/api_resource.py b/src/apideck/model/api_resource.py new file mode 100644 index 0000000000..adf688edd4 --- /dev/null +++ b/src/apideck/model/api_resource.py @@ -0,0 +1,279 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.api_resource_linked_resources import ApiResourceLinkedResources + from apideck.model.resource_status import ResourceStatus + globals()['ApiResourceLinkedResources'] = ApiResourceLinkedResources + globals()['ResourceStatus'] = ResourceStatus + + +class ApiResource(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'id': (str,), # noqa: E501 + 'name': (str,), # noqa: E501 + 'status': (ResourceStatus,), # noqa: E501 + 'linked_resources': ([ApiResourceLinkedResources],), # noqa: E501 + 'schema': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'name': 'name', # noqa: E501 + 'status': 'status', # noqa: E501 + 'linked_resources': 'linked_resources', # noqa: E501 + 'schema': 'schema', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ApiResource - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): ID of the resource, typically a lowercased version of name.. [optional] # noqa: E501 + name (str): Name of the resource (plural). [optional] # noqa: E501 + status (ResourceStatus): [optional] # noqa: E501 + linked_resources ([ApiResourceLinkedResources]): List of linked resources.. [optional] # noqa: E501 + schema ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): JSON Schema of the resource in our Unified API. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """ApiResource - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): ID of the resource, typically a lowercased version of name.. [optional] # noqa: E501 + name (str): Name of the resource (plural). [optional] # noqa: E501 + status (ResourceStatus): [optional] # noqa: E501 + linked_resources ([ApiResourceLinkedResources]): List of linked resources.. [optional] # noqa: E501 + schema ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): JSON Schema of the resource in our Unified API. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/api_resource_coverage.py b/src/apideck/model/api_resource_coverage.py new file mode 100644 index 0000000000..448734c1f1 --- /dev/null +++ b/src/apideck/model/api_resource_coverage.py @@ -0,0 +1,275 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.api_resource_coverage_coverage import ApiResourceCoverageCoverage + from apideck.model.resource_status import ResourceStatus + globals()['ApiResourceCoverageCoverage'] = ApiResourceCoverageCoverage + globals()['ResourceStatus'] = ResourceStatus + + +class ApiResourceCoverage(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'id': (str,), # noqa: E501 + 'name': (str,), # noqa: E501 + 'status': (ResourceStatus,), # noqa: E501 + 'coverage': ([ApiResourceCoverageCoverage],), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'name': 'name', # noqa: E501 + 'status': 'status', # noqa: E501 + 'coverage': 'coverage', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ApiResourceCoverage - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): ID of the resource, typically a lowercased version of name.. [optional] # noqa: E501 + name (str): Name of the resource (plural). [optional] # noqa: E501 + status (ResourceStatus): [optional] # noqa: E501 + coverage ([ApiResourceCoverageCoverage]): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """ApiResourceCoverage - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): ID of the resource, typically a lowercased version of name.. [optional] # noqa: E501 + name (str): Name of the resource (plural). [optional] # noqa: E501 + status (ResourceStatus): [optional] # noqa: E501 + coverage ([ApiResourceCoverageCoverage]): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/api_resource_coverage_coverage.py b/src/apideck/model/api_resource_coverage_coverage.py new file mode 100644 index 0000000000..8bde2cd30e --- /dev/null +++ b/src/apideck/model/api_resource_coverage_coverage.py @@ -0,0 +1,295 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.pagination_coverage import PaginationCoverage + from apideck.model.supported_property import SupportedProperty + globals()['PaginationCoverage'] = PaginationCoverage + globals()['SupportedProperty'] = SupportedProperty + + +class ApiResourceCoverageCoverage(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'downstream_id': (str,), # noqa: E501 + 'downstream_name': (str,), # noqa: E501 + 'pagination_supported': (bool,), # noqa: E501 + 'pagination': (PaginationCoverage,), # noqa: E501 + 'supported_operations': ([str],), # noqa: E501 + 'supported_filters': ([str],), # noqa: E501 + 'supported_sort_by': ([str],), # noqa: E501 + 'supported_fields': ([SupportedProperty],), # noqa: E501 + 'supported_list_fields': ([SupportedProperty],), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'downstream_id': 'downstream_id', # noqa: E501 + 'downstream_name': 'downstream_name', # noqa: E501 + 'pagination_supported': 'pagination_supported', # noqa: E501 + 'pagination': 'pagination', # noqa: E501 + 'supported_operations': 'supported_operations', # noqa: E501 + 'supported_filters': 'supported_filters', # noqa: E501 + 'supported_sort_by': 'supported_sort_by', # noqa: E501 + 'supported_fields': 'supported_fields', # noqa: E501 + 'supported_list_fields': 'supported_list_fields', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ApiResourceCoverageCoverage - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + downstream_id (str): ID of the resource in the Connector's API (downstream). [optional] # noqa: E501 + downstream_name (str): Name of the resource in the Connector's API (downstream). [optional] # noqa: E501 + pagination_supported (bool): Indicates if pagination (cursor and limit parameters) is supported on the list endpoint of the resource.. [optional] # noqa: E501 + pagination (PaginationCoverage): [optional] # noqa: E501 + supported_operations ([str]): List of supported operations on the resource.. [optional] # noqa: E501 + supported_filters ([str]): Supported filters on the list endpoint of the resource.. [optional] # noqa: E501 + supported_sort_by ([str]): Supported sorting properties on the list endpoint of the resource.. [optional] # noqa: E501 + supported_fields ([SupportedProperty]): Supported fields on the detail endpoint.. [optional] # noqa: E501 + supported_list_fields ([SupportedProperty]): Supported fields on the list endpoint.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """ApiResourceCoverageCoverage - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + downstream_id (str): ID of the resource in the Connector's API (downstream). [optional] # noqa: E501 + downstream_name (str): Name of the resource in the Connector's API (downstream). [optional] # noqa: E501 + pagination_supported (bool): Indicates if pagination (cursor and limit parameters) is supported on the list endpoint of the resource.. [optional] # noqa: E501 + pagination (PaginationCoverage): [optional] # noqa: E501 + supported_operations ([str]): List of supported operations on the resource.. [optional] # noqa: E501 + supported_filters ([str]): Supported filters on the list endpoint of the resource.. [optional] # noqa: E501 + supported_sort_by ([str]): Supported sorting properties on the list endpoint of the resource.. [optional] # noqa: E501 + supported_fields ([SupportedProperty]): Supported fields on the detail endpoint.. [optional] # noqa: E501 + supported_list_fields ([SupportedProperty]): Supported fields on the list endpoint.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/api_resource_linked_resources.py b/src/apideck/model/api_resource_linked_resources.py new file mode 100644 index 0000000000..920f8761ba --- /dev/null +++ b/src/apideck/model/api_resource_linked_resources.py @@ -0,0 +1,259 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class ApiResourceLinkedResources(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'id': (str,), # noqa: E501 + 'unified_property': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'unified_property': 'unified_property', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ApiResourceLinkedResources - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): ID of the resource, typically a lowercased version of name.. [optional] # noqa: E501 + unified_property (str): Name of the property in our Unified API.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """ApiResourceLinkedResources - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): ID of the resource, typically a lowercased version of name.. [optional] # noqa: E501 + unified_property (str): Name of the property in our Unified API.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/api_resources.py b/src/apideck/model/api_resources.py new file mode 100644 index 0000000000..4786106d4a --- /dev/null +++ b/src/apideck/model/api_resources.py @@ -0,0 +1,273 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.resource_status import ResourceStatus + globals()['ResourceStatus'] = ResourceStatus + + +class ApiResources(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'id': (str,), # noqa: E501 + 'name': (str,), # noqa: E501 + 'status': (ResourceStatus,), # noqa: E501 + 'excluded_from_coverage': (bool,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'name': 'name', # noqa: E501 + 'status': 'status', # noqa: E501 + 'excluded_from_coverage': 'excluded_from_coverage', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ApiResources - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): ID of the resource, typically a lowercased version of its name.. [optional] # noqa: E501 + name (str): Name of the resource (plural). [optional] # noqa: E501 + status (ResourceStatus): [optional] # noqa: E501 + excluded_from_coverage (bool): Exclude from mapping coverage. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """ApiResources - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): ID of the resource, typically a lowercased version of its name.. [optional] # noqa: E501 + name (str): Name of the resource (plural). [optional] # noqa: E501 + status (ResourceStatus): [optional] # noqa: E501 + excluded_from_coverage (bool): Exclude from mapping coverage. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/api_status.py b/src/apideck/model/api_status.py new file mode 100644 index 0000000000..22fb38ce5e --- /dev/null +++ b/src/apideck/model/api_status.py @@ -0,0 +1,284 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class ApiStatus(ModelSimple): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('value',): { + 'LIVE': "live", + 'BETA': "beta", + 'DEVELOPMENT': "development", + 'CONSIDERING': "considering", + }, + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'value': (str,), + } + + @cached_property + def discriminator(): + return None + + + attribute_map = {} + + read_only_vars = set() + + _composed_schemas = None + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): + """ApiStatus - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] (str): Status of the API. APIs with status live or beta are callable.., must be one of ["live", "beta", "development", "considering", ] # noqa: E501 + + Keyword Args: + value (str): Status of the API. APIs with status live or beta are callable.., must be one of ["live", "beta", "development", "considering", ] # noqa: E501 + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + self.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): + """ApiStatus - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] (str): Status of the API. APIs with status live or beta are callable.., must be one of ["live", "beta", "development", "considering", ] # noqa: E501 + + Keyword Args: + value (str): Status of the API. APIs with status live or beta are callable.., must be one of ["live", "beta", "development", "considering", ] # noqa: E501 + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + self.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + return self diff --git a/src/apideck/model/apis_filter.py b/src/apideck/model/apis_filter.py new file mode 100644 index 0000000000..5eebdf1c46 --- /dev/null +++ b/src/apideck/model/apis_filter.py @@ -0,0 +1,254 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.api_status import ApiStatus + globals()['ApiStatus'] = ApiStatus + + +class ApisFilter(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status': (ApiStatus,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status': 'status', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ApisFilter - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + status (ApiStatus): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """ApisFilter - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + status (ApiStatus): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/applicant.py b/src/apideck/model/applicant.py new file mode 100644 index 0000000000..e348b69b0a --- /dev/null +++ b/src/apideck/model/applicant.py @@ -0,0 +1,441 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.address import Address + from apideck.model.applicant_social_links import ApplicantSocialLinks + from apideck.model.applicant_websites import ApplicantWebsites + from apideck.model.email import Email + from apideck.model.phone_number import PhoneNumber + from apideck.model.tags import Tags + globals()['Address'] = Address + globals()['ApplicantSocialLinks'] = ApplicantSocialLinks + globals()['ApplicantWebsites'] = ApplicantWebsites + globals()['Email'] = Email + globals()['PhoneNumber'] = PhoneNumber + globals()['Tags'] = Tags + + +class Applicant(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'id': (str,), # noqa: E501 + 'position_id': (str,), # noqa: E501 + 'name': (str,), # noqa: E501 + 'first_name': (str, none_type,), # noqa: E501 + 'last_name': (str, none_type,), # noqa: E501 + 'middle_name': (str, none_type,), # noqa: E501 + 'initials': (str, none_type,), # noqa: E501 + 'birthday': (date, none_type,), # noqa: E501 + 'cover_letter': (str,), # noqa: E501 + 'job_url': (str, none_type,), # noqa: E501 + 'photo_url': (str, none_type,), # noqa: E501 + 'headline': (str,), # noqa: E501 + 'title': (str, none_type,), # noqa: E501 + 'emails': ([Email],), # noqa: E501 + 'phone_numbers': ([PhoneNumber],), # noqa: E501 + 'addresses': ([Address],), # noqa: E501 + 'websites': ([ApplicantWebsites],), # noqa: E501 + 'social_links': ([ApplicantSocialLinks],), # noqa: E501 + 'stage_id': (str,), # noqa: E501 + 'recruiter_id': (str,), # noqa: E501 + 'coordinator_id': (str,), # noqa: E501 + 'applications': ([str], none_type,), # noqa: E501 + 'followers': ([str], none_type,), # noqa: E501 + 'sources': ([str], none_type,), # noqa: E501 + 'source_id': (str,), # noqa: E501 + 'confidential': (bool,), # noqa: E501 + 'anonymized': (bool,), # noqa: E501 + 'tags': (Tags,), # noqa: E501 + 'archived': (bool,), # noqa: E501 + 'last_interaction_at': (datetime,), # noqa: E501 + 'owner_id': (str,), # noqa: E501 + 'sourced_by': (str, none_type,), # noqa: E501 + 'cv_url': (str,), # noqa: E501 + 'record_url': (str, none_type,), # noqa: E501 + 'rejected_at': (datetime, none_type,), # noqa: E501 + 'deleted': (bool, none_type,), # noqa: E501 + 'deleted_by': (str, none_type,), # noqa: E501 + 'deleted_at': (datetime, none_type,), # noqa: E501 + 'updated_by': (str, none_type,), # noqa: E501 + 'created_by': (str, none_type,), # noqa: E501 + 'updated_at': (datetime,), # noqa: E501 + 'created_at': (datetime,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'position_id': 'position_id', # noqa: E501 + 'name': 'name', # noqa: E501 + 'first_name': 'first_name', # noqa: E501 + 'last_name': 'last_name', # noqa: E501 + 'middle_name': 'middle_name', # noqa: E501 + 'initials': 'initials', # noqa: E501 + 'birthday': 'birthday', # noqa: E501 + 'cover_letter': 'cover_letter', # noqa: E501 + 'job_url': 'job_url', # noqa: E501 + 'photo_url': 'photo_url', # noqa: E501 + 'headline': 'headline', # noqa: E501 + 'title': 'title', # noqa: E501 + 'emails': 'emails', # noqa: E501 + 'phone_numbers': 'phone_numbers', # noqa: E501 + 'addresses': 'addresses', # noqa: E501 + 'websites': 'websites', # noqa: E501 + 'social_links': 'social_links', # noqa: E501 + 'stage_id': 'stage_id', # noqa: E501 + 'recruiter_id': 'recruiter_id', # noqa: E501 + 'coordinator_id': 'coordinator_id', # noqa: E501 + 'applications': 'applications', # noqa: E501 + 'followers': 'followers', # noqa: E501 + 'sources': 'sources', # noqa: E501 + 'source_id': 'source_id', # noqa: E501 + 'confidential': 'confidential', # noqa: E501 + 'anonymized': 'anonymized', # noqa: E501 + 'tags': 'tags', # noqa: E501 + 'archived': 'archived', # noqa: E501 + 'last_interaction_at': 'last_interaction_at', # noqa: E501 + 'owner_id': 'owner_id', # noqa: E501 + 'sourced_by': 'sourced_by', # noqa: E501 + 'cv_url': 'cv_url', # noqa: E501 + 'record_url': 'record_url', # noqa: E501 + 'rejected_at': 'rejected_at', # noqa: E501 + 'deleted': 'deleted', # noqa: E501 + 'deleted_by': 'deleted_by', # noqa: E501 + 'deleted_at': 'deleted_at', # noqa: E501 + 'updated_by': 'updated_by', # noqa: E501 + 'created_by': 'created_by', # noqa: E501 + 'updated_at': 'updated_at', # noqa: E501 + 'created_at': 'created_at', # noqa: E501 + } + + read_only_vars = { + 'id', # noqa: E501 + 'job_url', # noqa: E501 + 'source_id', # noqa: E501 + 'last_interaction_at', # noqa: E501 + 'sourced_by', # noqa: E501 + 'cv_url', # noqa: E501 + 'rejected_at', # noqa: E501 + 'deleted_by', # noqa: E501 + 'deleted_at', # noqa: E501 + 'updated_by', # noqa: E501 + 'created_by', # noqa: E501 + 'updated_at', # noqa: E501 + 'created_at', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """Applicant - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + position_id (str): The PositionId the applicant applied for.. [optional] # noqa: E501 + name (str): The name of an applicant.. [optional] # noqa: E501 + first_name (str, none_type): [optional] # noqa: E501 + last_name (str, none_type): [optional] # noqa: E501 + middle_name (str, none_type): [optional] # noqa: E501 + initials (str, none_type): [optional] # noqa: E501 + birthday (date, none_type): [optional] # noqa: E501 + cover_letter (str): [optional] # noqa: E501 + job_url (str, none_type): [optional] # noqa: E501 + photo_url (str, none_type): [optional] # noqa: E501 + headline (str): Typically a list of previous companies where the contact has worked or schools that the contact has attended. [optional] # noqa: E501 + title (str, none_type): [optional] # noqa: E501 + emails ([Email]): [optional] # noqa: E501 + phone_numbers ([PhoneNumber]): [optional] # noqa: E501 + addresses ([Address]): [optional] # noqa: E501 + websites ([ApplicantWebsites]): [optional] # noqa: E501 + social_links ([ApplicantSocialLinks]): [optional] # noqa: E501 + stage_id (str): [optional] # noqa: E501 + recruiter_id (str): [optional] # noqa: E501 + coordinator_id (str): [optional] # noqa: E501 + applications ([str], none_type): [optional] # noqa: E501 + followers ([str], none_type): [optional] # noqa: E501 + sources ([str], none_type): [optional] # noqa: E501 + source_id (str): [optional] # noqa: E501 + confidential (bool): [optional] # noqa: E501 + anonymized (bool): [optional] # noqa: E501 + tags (Tags): [optional] # noqa: E501 + archived (bool): [optional] # noqa: E501 + last_interaction_at (datetime): [optional] # noqa: E501 + owner_id (str): [optional] # noqa: E501 + sourced_by (str, none_type): [optional] # noqa: E501 + cv_url (str): [optional] # noqa: E501 + record_url (str, none_type): [optional] # noqa: E501 + rejected_at (datetime, none_type): [optional] # noqa: E501 + deleted (bool, none_type): [optional] # noqa: E501 + deleted_by (str, none_type): [optional] # noqa: E501 + deleted_at (datetime, none_type): [optional] # noqa: E501 + updated_by (str, none_type): [optional] # noqa: E501 + created_by (str, none_type): [optional] # noqa: E501 + updated_at (datetime): [optional] # noqa: E501 + created_at (datetime): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """Applicant - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + position_id (str): The PositionId the applicant applied for.. [optional] # noqa: E501 + name (str): The name of an applicant.. [optional] # noqa: E501 + first_name (str, none_type): [optional] # noqa: E501 + last_name (str, none_type): [optional] # noqa: E501 + middle_name (str, none_type): [optional] # noqa: E501 + initials (str, none_type): [optional] # noqa: E501 + birthday (date, none_type): [optional] # noqa: E501 + cover_letter (str): [optional] # noqa: E501 + job_url (str, none_type): [optional] # noqa: E501 + photo_url (str, none_type): [optional] # noqa: E501 + headline (str): Typically a list of previous companies where the contact has worked or schools that the contact has attended. [optional] # noqa: E501 + title (str, none_type): [optional] # noqa: E501 + emails ([Email]): [optional] # noqa: E501 + phone_numbers ([PhoneNumber]): [optional] # noqa: E501 + addresses ([Address]): [optional] # noqa: E501 + websites ([ApplicantWebsites]): [optional] # noqa: E501 + social_links ([ApplicantSocialLinks]): [optional] # noqa: E501 + stage_id (str): [optional] # noqa: E501 + recruiter_id (str): [optional] # noqa: E501 + coordinator_id (str): [optional] # noqa: E501 + applications ([str], none_type): [optional] # noqa: E501 + followers ([str], none_type): [optional] # noqa: E501 + sources ([str], none_type): [optional] # noqa: E501 + source_id (str): [optional] # noqa: E501 + confidential (bool): [optional] # noqa: E501 + anonymized (bool): [optional] # noqa: E501 + tags (Tags): [optional] # noqa: E501 + archived (bool): [optional] # noqa: E501 + last_interaction_at (datetime): [optional] # noqa: E501 + owner_id (str): [optional] # noqa: E501 + sourced_by (str, none_type): [optional] # noqa: E501 + cv_url (str): [optional] # noqa: E501 + record_url (str, none_type): [optional] # noqa: E501 + rejected_at (datetime, none_type): [optional] # noqa: E501 + deleted (bool, none_type): [optional] # noqa: E501 + deleted_by (str, none_type): [optional] # noqa: E501 + deleted_at (datetime, none_type): [optional] # noqa: E501 + updated_by (str, none_type): [optional] # noqa: E501 + created_by (str, none_type): [optional] # noqa: E501 + updated_at (datetime): [optional] # noqa: E501 + created_at (datetime): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/applicant_social_links.py b/src/apideck/model/applicant_social_links.py new file mode 100644 index 0000000000..7d76b3dcc3 --- /dev/null +++ b/src/apideck/model/applicant_social_links.py @@ -0,0 +1,272 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class ApplicantSocialLinks(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + ('url',): { + 'min_length': 1, + }, + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'url': (str,), # noqa: E501 + 'id': (str, none_type,), # noqa: E501 + 'type': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'url': 'url', # noqa: E501 + 'id': 'id', # noqa: E501 + 'type': 'type', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, url, *args, **kwargs): # noqa: E501 + """ApplicantSocialLinks - a model defined in OpenAPI + + Args: + url (str): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str, none_type): [optional] # noqa: E501 + type (str, none_type): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.url = url + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, url, *args, **kwargs): # noqa: E501 + """ApplicantSocialLinks - a model defined in OpenAPI + + Args: + url (str): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str, none_type): [optional] # noqa: E501 + type (str, none_type): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.url = url + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/applicant_websites.py b/src/apideck/model/applicant_websites.py new file mode 100644 index 0000000000..73c8e3c3f3 --- /dev/null +++ b/src/apideck/model/applicant_websites.py @@ -0,0 +1,279 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class ApplicantWebsites(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('type',): { + 'PRIMARY': "primary", + 'SECONDARY': "secondary", + 'WORK': "work", + 'PERSONAL': "personal", + 'OTHER': "other", + }, + } + + validations = { + ('url',): { + 'min_length': 1, + }, + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'url': (str,), # noqa: E501 + 'id': (str, none_type,), # noqa: E501 + 'type': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'url': 'url', # noqa: E501 + 'id': 'id', # noqa: E501 + 'type': 'type', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, url, *args, **kwargs): # noqa: E501 + """ApplicantWebsites - a model defined in OpenAPI + + Args: + url (str): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str, none_type): [optional] # noqa: E501 + type (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.url = url + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, url, *args, **kwargs): # noqa: E501 + """ApplicantWebsites - a model defined in OpenAPI + + Args: + url (str): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str, none_type): [optional] # noqa: E501 + type (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.url = url + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/applicants_filter.py b/src/apideck/model/applicants_filter.py new file mode 100644 index 0000000000..c015e83c6f --- /dev/null +++ b/src/apideck/model/applicants_filter.py @@ -0,0 +1,249 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class ApplicantsFilter(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'job_id': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'job_id': 'job_id', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ApplicantsFilter - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + job_id (str): Id of the job to filter on. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """ApplicantsFilter - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + job_id (str): Id of the job to filter on. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/ats_activity.py b/src/apideck/model/ats_activity.py new file mode 100644 index 0000000000..131056d183 --- /dev/null +++ b/src/apideck/model/ats_activity.py @@ -0,0 +1,270 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class AtsActivity(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'id': (str,), # noqa: E501 + 'updated_by': (str, none_type,), # noqa: E501 + 'created_by': (str, none_type,), # noqa: E501 + 'updated_at': (datetime,), # noqa: E501 + 'created_at': (datetime,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'updated_by': 'updated_by', # noqa: E501 + 'created_by': 'created_by', # noqa: E501 + 'updated_at': 'updated_at', # noqa: E501 + 'created_at': 'created_at', # noqa: E501 + } + + read_only_vars = { + 'id', # noqa: E501 + 'updated_by', # noqa: E501 + 'created_by', # noqa: E501 + 'updated_at', # noqa: E501 + 'created_at', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """AtsActivity - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + updated_by (str, none_type): [optional] # noqa: E501 + created_by (str, none_type): [optional] # noqa: E501 + updated_at (datetime): [optional] # noqa: E501 + created_at (datetime): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """AtsActivity - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + updated_by (str, none_type): [optional] # noqa: E501 + created_by (str, none_type): [optional] # noqa: E501 + updated_at (datetime): [optional] # noqa: E501 + created_at (datetime): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/ats_event_type.py b/src/apideck/model/ats_event_type.py new file mode 100644 index 0000000000..45758b5684 --- /dev/null +++ b/src/apideck/model/ats_event_type.py @@ -0,0 +1,286 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class AtsEventType(ModelSimple): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('value',): { + 'JOB.CREATED': "ats.job.created", + 'JOB.UPDATED': "ats.job.updated", + 'JOB.DELETED': "ats.job.deleted", + 'APPLICANT.CREATED': "ats.applicant.created", + 'APPLICANT.UPDATED': "ats.applicant.updated", + 'APPLICANT.DELETED': "ats.applicant.deleted", + }, + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'value': (str,), + } + + @cached_property + def discriminator(): + return None + + + attribute_map = {} + + read_only_vars = set() + + _composed_schemas = None + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): + """AtsEventType - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] (str):, must be one of ["ats.job.created", "ats.job.updated", "ats.job.deleted", "ats.applicant.created", "ats.applicant.updated", "ats.applicant.deleted", ] # noqa: E501 + + Keyword Args: + value (str):, must be one of ["ats.job.created", "ats.job.updated", "ats.job.deleted", "ats.applicant.created", "ats.applicant.updated", "ats.applicant.deleted", ] # noqa: E501 + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + self.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): + """AtsEventType - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] (str):, must be one of ["ats.job.created", "ats.job.updated", "ats.job.deleted", "ats.applicant.created", "ats.applicant.updated", "ats.applicant.deleted", ] # noqa: E501 + + Keyword Args: + value (str):, must be one of ["ats.job.created", "ats.job.updated", "ats.job.deleted", "ats.applicant.created", "ats.applicant.updated", "ats.applicant.deleted", ] # noqa: E501 + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + self.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + return self diff --git a/src/apideck/model/auth_type.py b/src/apideck/model/auth_type.py new file mode 100644 index 0000000000..0de973d7a5 --- /dev/null +++ b/src/apideck/model/auth_type.py @@ -0,0 +1,285 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class AuthType(ModelSimple): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('value',): { + 'OAUTH2': "oauth2", + 'APIKEY': "apiKey", + 'BASIC': "basic", + 'CUSTOM': "custom", + 'NONE': "none", + }, + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'value': (str,), + } + + @cached_property + def discriminator(): + return None + + + attribute_map = {} + + read_only_vars = set() + + _composed_schemas = None + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): + """AuthType - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] (str): Type of authorization used by the connector., must be one of ["oauth2", "apiKey", "basic", "custom", "none", ] # noqa: E501 + + Keyword Args: + value (str): Type of authorization used by the connector., must be one of ["oauth2", "apiKey", "basic", "custom", "none", ] # noqa: E501 + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + self.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): + """AuthType - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] (str): Type of authorization used by the connector., must be one of ["oauth2", "apiKey", "basic", "custom", "none", ] # noqa: E501 + + Keyword Args: + value (str): Type of authorization used by the connector., must be one of ["oauth2", "apiKey", "basic", "custom", "none", ] # noqa: E501 + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + self.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + return self diff --git a/src/apideck/model/bad_request_response.py b/src/apideck/model/bad_request_response.py new file mode 100644 index 0000000000..39fbbee8f8 --- /dev/null +++ b/src/apideck/model/bad_request_response.py @@ -0,0 +1,275 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class BadRequestResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'status_code': (float,), # noqa: E501 + 'error': (str,), # noqa: E501 + 'type_name': (str,), # noqa: E501 + 'message': (str,), # noqa: E501 + 'detail': (bool, date, datetime, dict, float, int, list, str, none_type,), # noqa: E501 + 'ref': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'error': 'error', # noqa: E501 + 'type_name': 'type_name', # noqa: E501 + 'message': 'message', # noqa: E501 + 'detail': 'detail', # noqa: E501 + 'ref': 'ref', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """BadRequestResponse - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + status_code (float): HTTP status code. [optional] # noqa: E501 + error (str): Contains an explanation of the status_code as defined in HTTP/1.1 standard (RFC 7231). [optional] # noqa: E501 + type_name (str): The type of error returned. [optional] # noqa: E501 + message (str): A human-readable message providing more details about the error.. [optional] # noqa: E501 + detail (bool, date, datetime, dict, float, int, list, str, none_type): Contains parameter or domain specific information related to the error and why it occurred.. [optional] # noqa: E501 + ref (str): Link to documentation of error type. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """BadRequestResponse - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + status_code (float): HTTP status code. [optional] # noqa: E501 + error (str): Contains an explanation of the status_code as defined in HTTP/1.1 standard (RFC 7231). [optional] # noqa: E501 + type_name (str): The type of error returned. [optional] # noqa: E501 + message (str): A human-readable message providing more details about the error.. [optional] # noqa: E501 + detail (bool, date, datetime, dict, float, int, list, str, none_type): Contains parameter or domain specific information related to the error and why it occurred.. [optional] # noqa: E501 + ref (str): Link to documentation of error type. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/balance_sheet.py b/src/apideck/model/balance_sheet.py new file mode 100644 index 0000000000..aa116a90a4 --- /dev/null +++ b/src/apideck/model/balance_sheet.py @@ -0,0 +1,327 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.balance_sheet_assets import BalanceSheetAssets + from apideck.model.balance_sheet_equity import BalanceSheetEquity + from apideck.model.balance_sheet_liabilities import BalanceSheetLiabilities + globals()['BalanceSheetAssets'] = BalanceSheetAssets + globals()['BalanceSheetEquity'] = BalanceSheetEquity + globals()['BalanceSheetLiabilities'] = BalanceSheetLiabilities + + +class BalanceSheet(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + ('start_date',): { + 'regex': { + 'pattern': r'^\d{4}-\d{2}-\d{2}$', # noqa: E501 + }, + }, + ('end_date',): { + 'regex': { + 'pattern': r'^\d{4}-\d{2}-\d{2}$', # noqa: E501 + }, + }, + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'report_name': (str,), # noqa: E501 + 'start_date': (str,), # noqa: E501 + 'assets': (BalanceSheetAssets,), # noqa: E501 + 'liabilities': (BalanceSheetLiabilities,), # noqa: E501 + 'equity': (BalanceSheetEquity,), # noqa: E501 + 'id': (str,), # noqa: E501 + 'end_date': (str,), # noqa: E501 + 'updated_by': (str, none_type,), # noqa: E501 + 'created_by': (str, none_type,), # noqa: E501 + 'updated_at': (datetime,), # noqa: E501 + 'created_at': (datetime,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'report_name': 'report_name', # noqa: E501 + 'start_date': 'start_date', # noqa: E501 + 'assets': 'assets', # noqa: E501 + 'liabilities': 'liabilities', # noqa: E501 + 'equity': 'equity', # noqa: E501 + 'id': 'id', # noqa: E501 + 'end_date': 'end_date', # noqa: E501 + 'updated_by': 'updated_by', # noqa: E501 + 'created_by': 'created_by', # noqa: E501 + 'updated_at': 'updated_at', # noqa: E501 + 'created_at': 'created_at', # noqa: E501 + } + + read_only_vars = { + 'id', # noqa: E501 + 'updated_by', # noqa: E501 + 'created_by', # noqa: E501 + 'updated_at', # noqa: E501 + 'created_at', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, report_name, start_date, assets, liabilities, equity, *args, **kwargs): # noqa: E501 + """BalanceSheet - a model defined in OpenAPI + + Args: + report_name (str): The name of the report + start_date (str): The start date of the report + assets (BalanceSheetAssets): + liabilities (BalanceSheetLiabilities): + equity (BalanceSheetEquity): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + end_date (str): The start date of the report. [optional] # noqa: E501 + updated_by (str, none_type): [optional] # noqa: E501 + created_by (str, none_type): [optional] # noqa: E501 + updated_at (datetime): [optional] # noqa: E501 + created_at (datetime): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.report_name = report_name + self.start_date = start_date + self.assets = assets + self.liabilities = liabilities + self.equity = equity + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, report_name, start_date, assets, liabilities, equity, *args, **kwargs): # noqa: E501 + """BalanceSheet - a model defined in OpenAPI + + Args: + report_name (str): The name of the report + start_date (str): The start date of the report + assets (BalanceSheetAssets): + liabilities (BalanceSheetLiabilities): + equity (BalanceSheetEquity): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + end_date (str): The start date of the report. [optional] # noqa: E501 + updated_by (str, none_type): [optional] # noqa: E501 + created_by (str, none_type): [optional] # noqa: E501 + updated_at (datetime): [optional] # noqa: E501 + created_at (datetime): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.report_name = report_name + self.start_date = start_date + self.assets = assets + self.liabilities = liabilities + self.equity = equity + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/balance_sheet_assets.py b/src/apideck/model/balance_sheet_assets.py new file mode 100644 index 0000000000..4a866acef2 --- /dev/null +++ b/src/apideck/model/balance_sheet_assets.py @@ -0,0 +1,281 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.balance_sheet_assets_current_assets import BalanceSheetAssetsCurrentAssets + from apideck.model.balance_sheet_assets_fixed_assets import BalanceSheetAssetsFixedAssets + globals()['BalanceSheetAssetsCurrentAssets'] = BalanceSheetAssetsCurrentAssets + globals()['BalanceSheetAssetsFixedAssets'] = BalanceSheetAssetsFixedAssets + + +class BalanceSheetAssets(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'total': (float,), # noqa: E501 + 'current_assets': (BalanceSheetAssetsCurrentAssets,), # noqa: E501 + 'fixed_assets': (BalanceSheetAssetsFixedAssets,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'total': 'total', # noqa: E501 + 'current_assets': 'current_assets', # noqa: E501 + 'fixed_assets': 'fixed_assets', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, total, current_assets, fixed_assets, *args, **kwargs): # noqa: E501 + """BalanceSheetAssets - a model defined in OpenAPI + + Args: + total (float): Total assets + current_assets (BalanceSheetAssetsCurrentAssets): + fixed_assets (BalanceSheetAssetsFixedAssets): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.total = total + self.current_assets = current_assets + self.fixed_assets = fixed_assets + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, total, current_assets, fixed_assets, *args, **kwargs): # noqa: E501 + """BalanceSheetAssets - a model defined in OpenAPI + + Args: + total (float): Total assets + current_assets (BalanceSheetAssetsCurrentAssets): + fixed_assets (BalanceSheetAssetsFixedAssets): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.total = total + self.current_assets = current_assets + self.fixed_assets = fixed_assets + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/balance_sheet_assets_current_assets.py b/src/apideck/model/balance_sheet_assets_current_assets.py new file mode 100644 index 0000000000..70482e9c06 --- /dev/null +++ b/src/apideck/model/balance_sheet_assets_current_assets.py @@ -0,0 +1,273 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.balance_sheet_assets_current_assets_accounts import BalanceSheetAssetsCurrentAssetsAccounts + globals()['BalanceSheetAssetsCurrentAssetsAccounts'] = BalanceSheetAssetsCurrentAssetsAccounts + + +class BalanceSheetAssetsCurrentAssets(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'total': (float,), # noqa: E501 + 'accounts': ([BalanceSheetAssetsCurrentAssetsAccounts],), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'total': 'total', # noqa: E501 + 'accounts': 'accounts', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, total, accounts, *args, **kwargs): # noqa: E501 + """BalanceSheetAssetsCurrentAssets - a model defined in OpenAPI + + Args: + total (float): Total current assets + accounts ([BalanceSheetAssetsCurrentAssetsAccounts]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.total = total + self.accounts = accounts + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, total, accounts, *args, **kwargs): # noqa: E501 + """BalanceSheetAssetsCurrentAssets - a model defined in OpenAPI + + Args: + total (float): Total current assets + accounts ([BalanceSheetAssetsCurrentAssetsAccounts]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.total = total + self.accounts = accounts + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/balance_sheet_assets_current_assets_accounts.py b/src/apideck/model/balance_sheet_assets_current_assets_accounts.py new file mode 100644 index 0000000000..07749759d4 --- /dev/null +++ b/src/apideck/model/balance_sheet_assets_current_assets_accounts.py @@ -0,0 +1,264 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class BalanceSheetAssetsCurrentAssetsAccounts(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'id': (str,), # noqa: E501 + 'name': (str,), # noqa: E501 + 'value': (float,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'name': 'name', # noqa: E501 + 'value': 'value', # noqa: E501 + } + + read_only_vars = { + 'id', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """BalanceSheetAssetsCurrentAssetsAccounts - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + name (str): The name of the current asset account. [optional] # noqa: E501 + value (float): The value of the current asset. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """BalanceSheetAssetsCurrentAssetsAccounts - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + name (str): The name of the current asset account. [optional] # noqa: E501 + value (float): The value of the current asset. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/balance_sheet_assets_fixed_assets.py b/src/apideck/model/balance_sheet_assets_fixed_assets.py new file mode 100644 index 0000000000..c97c03e0f4 --- /dev/null +++ b/src/apideck/model/balance_sheet_assets_fixed_assets.py @@ -0,0 +1,273 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.balance_sheet_assets_fixed_assets_accounts import BalanceSheetAssetsFixedAssetsAccounts + globals()['BalanceSheetAssetsFixedAssetsAccounts'] = BalanceSheetAssetsFixedAssetsAccounts + + +class BalanceSheetAssetsFixedAssets(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'total': (float,), # noqa: E501 + 'accounts': ([BalanceSheetAssetsFixedAssetsAccounts],), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'total': 'total', # noqa: E501 + 'accounts': 'accounts', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, total, accounts, *args, **kwargs): # noqa: E501 + """BalanceSheetAssetsFixedAssets - a model defined in OpenAPI + + Args: + total (float): Total fixed assets + accounts ([BalanceSheetAssetsFixedAssetsAccounts]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.total = total + self.accounts = accounts + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, total, accounts, *args, **kwargs): # noqa: E501 + """BalanceSheetAssetsFixedAssets - a model defined in OpenAPI + + Args: + total (float): Total fixed assets + accounts ([BalanceSheetAssetsFixedAssetsAccounts]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.total = total + self.accounts = accounts + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/balance_sheet_assets_fixed_assets_accounts.py b/src/apideck/model/balance_sheet_assets_fixed_assets_accounts.py new file mode 100644 index 0000000000..ebab425ad4 --- /dev/null +++ b/src/apideck/model/balance_sheet_assets_fixed_assets_accounts.py @@ -0,0 +1,264 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class BalanceSheetAssetsFixedAssetsAccounts(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'id': (str,), # noqa: E501 + 'name': (str,), # noqa: E501 + 'value': (float,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'name': 'name', # noqa: E501 + 'value': 'value', # noqa: E501 + } + + read_only_vars = { + 'id', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """BalanceSheetAssetsFixedAssetsAccounts - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + name (str): The name of the fixed asset account. [optional] # noqa: E501 + value (float): The value of the fixed asset. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """BalanceSheetAssetsFixedAssetsAccounts - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + name (str): The name of the fixed asset account. [optional] # noqa: E501 + value (float): The value of the fixed asset. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/balance_sheet_equity.py b/src/apideck/model/balance_sheet_equity.py new file mode 100644 index 0000000000..f29843a48b --- /dev/null +++ b/src/apideck/model/balance_sheet_equity.py @@ -0,0 +1,273 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.balance_sheet_equity_items import BalanceSheetEquityItems + globals()['BalanceSheetEquityItems'] = BalanceSheetEquityItems + + +class BalanceSheetEquity(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'total': (float,), # noqa: E501 + 'items': ([BalanceSheetEquityItems],), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'total': 'total', # noqa: E501 + 'items': 'items', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, total, items, *args, **kwargs): # noqa: E501 + """BalanceSheetEquity - a model defined in OpenAPI + + Args: + total (float): Total equity + items ([BalanceSheetEquityItems]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.total = total + self.items = items + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, total, items, *args, **kwargs): # noqa: E501 + """BalanceSheetEquity - a model defined in OpenAPI + + Args: + total (float): Total equity + items ([BalanceSheetEquityItems]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.total = total + self.items = items + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/balance_sheet_equity_items.py b/src/apideck/model/balance_sheet_equity_items.py new file mode 100644 index 0000000000..45cc059948 --- /dev/null +++ b/src/apideck/model/balance_sheet_equity_items.py @@ -0,0 +1,264 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class BalanceSheetEquityItems(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'id': (str,), # noqa: E501 + 'name': (str,), # noqa: E501 + 'value': (float,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'name': 'name', # noqa: E501 + 'value': 'value', # noqa: E501 + } + + read_only_vars = { + 'id', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """BalanceSheetEquityItems - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + name (str): The type of the equity. [optional] # noqa: E501 + value (float): The equity amount. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """BalanceSheetEquityItems - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + name (str): The type of the equity. [optional] # noqa: E501 + value (float): The equity amount. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/balance_sheet_filter.py b/src/apideck/model/balance_sheet_filter.py new file mode 100644 index 0000000000..77bcf67269 --- /dev/null +++ b/src/apideck/model/balance_sheet_filter.py @@ -0,0 +1,253 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class BalanceSheetFilter(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'start_date': (str,), # noqa: E501 + 'end_date': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'start_date': 'start_date', # noqa: E501 + 'end_date': 'end_date', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """BalanceSheetFilter - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + start_date (str): Filter by start date. If start date is given, end date is required.. [optional] # noqa: E501 + end_date (str): Filter by end date. If end date is given, start date is required.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """BalanceSheetFilter - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + start_date (str): Filter by start date. If start date is given, end date is required.. [optional] # noqa: E501 + end_date (str): Filter by end date. If end date is given, start date is required.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/balance_sheet_liabilities.py b/src/apideck/model/balance_sheet_liabilities.py new file mode 100644 index 0000000000..cc3096e66c --- /dev/null +++ b/src/apideck/model/balance_sheet_liabilities.py @@ -0,0 +1,273 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.balance_sheet_liabilities_accounts import BalanceSheetLiabilitiesAccounts + globals()['BalanceSheetLiabilitiesAccounts'] = BalanceSheetLiabilitiesAccounts + + +class BalanceSheetLiabilities(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'total': (float,), # noqa: E501 + 'accounts': ([BalanceSheetLiabilitiesAccounts],), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'total': 'total', # noqa: E501 + 'accounts': 'accounts', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, total, accounts, *args, **kwargs): # noqa: E501 + """BalanceSheetLiabilities - a model defined in OpenAPI + + Args: + total (float): Total liabilities + accounts ([BalanceSheetLiabilitiesAccounts]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.total = total + self.accounts = accounts + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, total, accounts, *args, **kwargs): # noqa: E501 + """BalanceSheetLiabilities - a model defined in OpenAPI + + Args: + total (float): Total liabilities + accounts ([BalanceSheetLiabilitiesAccounts]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.total = total + self.accounts = accounts + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/balance_sheet_liabilities_accounts.py b/src/apideck/model/balance_sheet_liabilities_accounts.py new file mode 100644 index 0000000000..a0a86982e2 --- /dev/null +++ b/src/apideck/model/balance_sheet_liabilities_accounts.py @@ -0,0 +1,264 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class BalanceSheetLiabilitiesAccounts(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'id': (str,), # noqa: E501 + 'name': (str,), # noqa: E501 + 'value': (float,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'name': 'name', # noqa: E501 + 'value': 'value', # noqa: E501 + } + + read_only_vars = { + 'id', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """BalanceSheetLiabilitiesAccounts - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + name (str): The name of the liability account. [optional] # noqa: E501 + value (float): The value of the liability. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """BalanceSheetLiabilitiesAccounts - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + name (str): The name of the liability account. [optional] # noqa: E501 + value (float): The value of the liability. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/bank_account.py b/src/apideck/model/bank_account.py new file mode 100644 index 0000000000..4a24e24339 --- /dev/null +++ b/src/apideck/model/bank_account.py @@ -0,0 +1,292 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.currency import Currency + globals()['Currency'] = Currency + + +class BankAccount(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('account_type',): { + 'None': None, + 'BANK_ACCOUNT': "bank_account", + 'CREDIT_CARD': "credit_card", + 'OTHER': "other", + }, + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'iban': (str, none_type,), # noqa: E501 + 'bic': (str, none_type,), # noqa: E501 + 'bsb_number': (str, none_type,), # noqa: E501 + 'branch_identifier': (str, none_type,), # noqa: E501 + 'bank_code': (str, none_type,), # noqa: E501 + 'account_number': (str, none_type,), # noqa: E501 + 'account_name': (str, none_type,), # noqa: E501 + 'account_type': (str, none_type,), # noqa: E501 + 'currency': (Currency,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'iban': 'iban', # noqa: E501 + 'bic': 'bic', # noqa: E501 + 'bsb_number': 'bsb_number', # noqa: E501 + 'branch_identifier': 'branch_identifier', # noqa: E501 + 'bank_code': 'bank_code', # noqa: E501 + 'account_number': 'account_number', # noqa: E501 + 'account_name': 'account_name', # noqa: E501 + 'account_type': 'account_type', # noqa: E501 + 'currency': 'currency', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """BankAccount - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + iban (str, none_type): [optional] # noqa: E501 + bic (str, none_type): [optional] # noqa: E501 + bsb_number (str, none_type): A BSB is a 6 digit numeric code used for identifying the branch of an Australian or New Zealand bank or financial institution.. [optional] # noqa: E501 + branch_identifier (str, none_type): A branch identifier is a unique identifier for a branch of a bank or financial institution.. [optional] # noqa: E501 + bank_code (str, none_type): A bank code is a code assigned by a central bank, a bank supervisory body or a Bankers Association in a country to all its licensed member banks or financial institutions.. [optional] # noqa: E501 + account_number (str, none_type): A bank account number is a number that is tied to your bank account. If you have several bank accounts, such as personal, joint, business (and so on), each account will have a different account number.. [optional] # noqa: E501 + account_name (str, none_type): The name which you used in opening your bank account.. [optional] # noqa: E501 + account_type (str, none_type): The type of bank account.. [optional] # noqa: E501 + currency (Currency): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """BankAccount - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + iban (str, none_type): [optional] # noqa: E501 + bic (str, none_type): [optional] # noqa: E501 + bsb_number (str, none_type): A BSB is a 6 digit numeric code used for identifying the branch of an Australian or New Zealand bank or financial institution.. [optional] # noqa: E501 + branch_identifier (str, none_type): A branch identifier is a unique identifier for a branch of a bank or financial institution.. [optional] # noqa: E501 + bank_code (str, none_type): A bank code is a code assigned by a central bank, a bank supervisory body or a Bankers Association in a country to all its licensed member banks or financial institutions.. [optional] # noqa: E501 + account_number (str, none_type): A bank account number is a number that is tied to your bank account. If you have several bank accounts, such as personal, joint, business (and so on), each account will have a different account number.. [optional] # noqa: E501 + account_name (str, none_type): The name which you used in opening your bank account.. [optional] # noqa: E501 + account_type (str, none_type): The type of bank account.. [optional] # noqa: E501 + currency (Currency): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/benefit.py b/src/apideck/model/benefit.py new file mode 100644 index 0000000000..8dfd2bd1c7 --- /dev/null +++ b/src/apideck/model/benefit.py @@ -0,0 +1,263 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class Benefit(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'name': (str,), # noqa: E501 + 'employee_deduction': (float,), # noqa: E501 + 'employer_contribution': (float,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'name': 'name', # noqa: E501 + 'employee_deduction': 'employee_deduction', # noqa: E501 + 'employer_contribution': 'employer_contribution', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """Benefit - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + name (str): The name of the benefit.. [optional] # noqa: E501 + employee_deduction (float): The amount deducted for benefit.. [optional] # noqa: E501 + employer_contribution (float): The amount of employer contribution.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """Benefit - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + name (str): The name of the benefit.. [optional] # noqa: E501 + employee_deduction (float): The amount deducted for benefit.. [optional] # noqa: E501 + employer_contribution (float): The amount of employer contribution.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/bill.py b/src/apideck/model/bill.py new file mode 100644 index 0000000000..af89afc588 --- /dev/null +++ b/src/apideck/model/bill.py @@ -0,0 +1,385 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.bill_line_item import BillLineItem + from apideck.model.currency import Currency + from apideck.model.linked_ledger_account import LinkedLedgerAccount + from apideck.model.linked_supplier import LinkedSupplier + globals()['BillLineItem'] = BillLineItem + globals()['Currency'] = Currency + globals()['LinkedLedgerAccount'] = LinkedLedgerAccount + globals()['LinkedSupplier'] = LinkedSupplier + + +class Bill(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('status',): { + 'None': None, + 'DRAFT': "draft", + 'SUBMITTED': "submitted", + 'AUTHORISED': "authorised", + 'PARTIALLY_PAID': "partially_paid", + 'PAID': "paid", + 'VOID': "void", + 'CREDIT': "credit", + 'DELETED': "deleted", + }, + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'id': (str,), # noqa: E501 + 'downstream_id': (str, none_type,), # noqa: E501 + 'supplier': (LinkedSupplier,), # noqa: E501 + 'currency': (Currency,), # noqa: E501 + 'currency_rate': (float, none_type,), # noqa: E501 + 'tax_inclusive': (bool, none_type,), # noqa: E501 + 'bill_date': (date,), # noqa: E501 + 'due_date': (date,), # noqa: E501 + 'paid_date': (date, none_type,), # noqa: E501 + 'po_number': (str, none_type,), # noqa: E501 + 'reference': (str, none_type,), # noqa: E501 + 'line_items': ([BillLineItem],), # noqa: E501 + 'terms': (str, none_type,), # noqa: E501 + 'balance': (float, none_type,), # noqa: E501 + 'deposit': (float, none_type,), # noqa: E501 + 'sub_total': (float, none_type,), # noqa: E501 + 'total_tax': (float, none_type,), # noqa: E501 + 'total': (float, none_type,), # noqa: E501 + 'tax_code': (str, none_type,), # noqa: E501 + 'notes': (str, none_type,), # noqa: E501 + 'status': (str, none_type,), # noqa: E501 + 'ledger_account': (LinkedLedgerAccount,), # noqa: E501 + 'bill_number': (str, none_type,), # noqa: E501 + 'updated_by': (str, none_type,), # noqa: E501 + 'created_by': (str, none_type,), # noqa: E501 + 'updated_at': (datetime,), # noqa: E501 + 'created_at': (datetime,), # noqa: E501 + 'row_version': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'downstream_id': 'downstream_id', # noqa: E501 + 'supplier': 'supplier', # noqa: E501 + 'currency': 'currency', # noqa: E501 + 'currency_rate': 'currency_rate', # noqa: E501 + 'tax_inclusive': 'tax_inclusive', # noqa: E501 + 'bill_date': 'bill_date', # noqa: E501 + 'due_date': 'due_date', # noqa: E501 + 'paid_date': 'paid_date', # noqa: E501 + 'po_number': 'po_number', # noqa: E501 + 'reference': 'reference', # noqa: E501 + 'line_items': 'line_items', # noqa: E501 + 'terms': 'terms', # noqa: E501 + 'balance': 'balance', # noqa: E501 + 'deposit': 'deposit', # noqa: E501 + 'sub_total': 'sub_total', # noqa: E501 + 'total_tax': 'total_tax', # noqa: E501 + 'total': 'total', # noqa: E501 + 'tax_code': 'tax_code', # noqa: E501 + 'notes': 'notes', # noqa: E501 + 'status': 'status', # noqa: E501 + 'ledger_account': 'ledger_account', # noqa: E501 + 'bill_number': 'bill_number', # noqa: E501 + 'updated_by': 'updated_by', # noqa: E501 + 'created_by': 'created_by', # noqa: E501 + 'updated_at': 'updated_at', # noqa: E501 + 'created_at': 'created_at', # noqa: E501 + 'row_version': 'row_version', # noqa: E501 + } + + read_only_vars = { + 'id', # noqa: E501 + 'downstream_id', # noqa: E501 + 'updated_by', # noqa: E501 + 'created_by', # noqa: E501 + 'updated_at', # noqa: E501 + 'created_at', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """Bill - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + downstream_id (str, none_type): The third-party API ID of original entity. [optional] # noqa: E501 + supplier (LinkedSupplier): [optional] # noqa: E501 + currency (Currency): [optional] # noqa: E501 + currency_rate (float, none_type): Currency Exchange Rate at the time entity was recorded/generated.. [optional] # noqa: E501 + tax_inclusive (bool, none_type): Amounts are including tax. [optional] # noqa: E501 + bill_date (date): Date bill was issued - YYYY-MM-DD.. [optional] # noqa: E501 + due_date (date): The due date is the date on which a payment is scheduled to be received by the supplier - YYYY-MM-DD.. [optional] # noqa: E501 + paid_date (date, none_type): The paid date is the date on which a payment was sent to the supplier - YYYY-MM-DD.. [optional] # noqa: E501 + po_number (str, none_type): A PO Number uniquely identifies a purchase order and is generally defined by the buyer. The buyer will match the PO number in the invoice to the Purchase Order.. [optional] # noqa: E501 + reference (str, none_type): Optional invoice reference.. [optional] # noqa: E501 + line_items ([BillLineItem]): [optional] # noqa: E501 + terms (str, none_type): Terms of payment.. [optional] # noqa: E501 + balance (float, none_type): Balance of bill due.. [optional] # noqa: E501 + deposit (float, none_type): Amount of deposit made to this bill.. [optional] # noqa: E501 + sub_total (float, none_type): Sub-total amount, normally before tax.. [optional] # noqa: E501 + total_tax (float, none_type): Total tax amount applied to this bill.. [optional] # noqa: E501 + total (float, none_type): Total amount of bill, including tax.. [optional] # noqa: E501 + tax_code (str, none_type): Applicable tax id/code override if tax is not supplied on a line item basis.. [optional] # noqa: E501 + notes (str, none_type): [optional] # noqa: E501 + status (str, none_type): Invoice status. [optional] # noqa: E501 + ledger_account (LinkedLedgerAccount): [optional] # noqa: E501 + bill_number (str, none_type): [optional] # noqa: E501 + updated_by (str, none_type): [optional] # noqa: E501 + created_by (str, none_type): [optional] # noqa: E501 + updated_at (datetime): [optional] # noqa: E501 + created_at (datetime): [optional] # noqa: E501 + row_version (str, none_type): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """Bill - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + downstream_id (str, none_type): The third-party API ID of original entity. [optional] # noqa: E501 + supplier (LinkedSupplier): [optional] # noqa: E501 + currency (Currency): [optional] # noqa: E501 + currency_rate (float, none_type): Currency Exchange Rate at the time entity was recorded/generated.. [optional] # noqa: E501 + tax_inclusive (bool, none_type): Amounts are including tax. [optional] # noqa: E501 + bill_date (date): Date bill was issued - YYYY-MM-DD.. [optional] # noqa: E501 + due_date (date): The due date is the date on which a payment is scheduled to be received by the supplier - YYYY-MM-DD.. [optional] # noqa: E501 + paid_date (date, none_type): The paid date is the date on which a payment was sent to the supplier - YYYY-MM-DD.. [optional] # noqa: E501 + po_number (str, none_type): A PO Number uniquely identifies a purchase order and is generally defined by the buyer. The buyer will match the PO number in the invoice to the Purchase Order.. [optional] # noqa: E501 + reference (str, none_type): Optional invoice reference.. [optional] # noqa: E501 + line_items ([BillLineItem]): [optional] # noqa: E501 + terms (str, none_type): Terms of payment.. [optional] # noqa: E501 + balance (float, none_type): Balance of bill due.. [optional] # noqa: E501 + deposit (float, none_type): Amount of deposit made to this bill.. [optional] # noqa: E501 + sub_total (float, none_type): Sub-total amount, normally before tax.. [optional] # noqa: E501 + total_tax (float, none_type): Total tax amount applied to this bill.. [optional] # noqa: E501 + total (float, none_type): Total amount of bill, including tax.. [optional] # noqa: E501 + tax_code (str, none_type): Applicable tax id/code override if tax is not supplied on a line item basis.. [optional] # noqa: E501 + notes (str, none_type): [optional] # noqa: E501 + status (str, none_type): Invoice status. [optional] # noqa: E501 + ledger_account (LinkedLedgerAccount): [optional] # noqa: E501 + bill_number (str, none_type): [optional] # noqa: E501 + updated_by (str, none_type): [optional] # noqa: E501 + created_by (str, none_type): [optional] # noqa: E501 + updated_at (datetime): [optional] # noqa: E501 + created_at (datetime): [optional] # noqa: E501 + row_version (str, none_type): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/bill_line_item.py b/src/apideck/model/bill_line_item.py new file mode 100644 index 0000000000..afc89dcc3d --- /dev/null +++ b/src/apideck/model/bill_line_item.py @@ -0,0 +1,352 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.linked_invoice_item import LinkedInvoiceItem + from apideck.model.linked_ledger_account import LinkedLedgerAccount + from apideck.model.linked_tax_rate import LinkedTaxRate + globals()['LinkedInvoiceItem'] = LinkedInvoiceItem + globals()['LinkedLedgerAccount'] = LinkedLedgerAccount + globals()['LinkedTaxRate'] = LinkedTaxRate + + +class BillLineItem(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('type',): { + 'None': None, + 'ITEM': "expense_item", + 'ACCOUNT': "expense_account", + }, + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'id': (str,), # noqa: E501 + 'row_id': (str,), # noqa: E501 + 'code': (str, none_type,), # noqa: E501 + 'line_number': (int, none_type,), # noqa: E501 + 'description': (str, none_type,), # noqa: E501 + 'type': (str, none_type,), # noqa: E501 + 'tax_amount': (float, none_type,), # noqa: E501 + 'total_amount': (float, none_type,), # noqa: E501 + 'quantity': (float, none_type,), # noqa: E501 + 'unit_price': (float, none_type,), # noqa: E501 + 'unit_of_measure': (str, none_type,), # noqa: E501 + 'discount_percentage': (float, none_type,), # noqa: E501 + 'location_id': (str, none_type,), # noqa: E501 + 'department_id': (str, none_type,), # noqa: E501 + 'item': (LinkedInvoiceItem,), # noqa: E501 + 'ledger_account': (LinkedLedgerAccount,), # noqa: E501 + 'tax_rate': (LinkedTaxRate,), # noqa: E501 + 'row_version': (str, none_type,), # noqa: E501 + 'updated_by': (str, none_type,), # noqa: E501 + 'created_by': (str, none_type,), # noqa: E501 + 'created_at': (datetime,), # noqa: E501 + 'updated_at': (datetime,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'row_id': 'row_id', # noqa: E501 + 'code': 'code', # noqa: E501 + 'line_number': 'line_number', # noqa: E501 + 'description': 'description', # noqa: E501 + 'type': 'type', # noqa: E501 + 'tax_amount': 'tax_amount', # noqa: E501 + 'total_amount': 'total_amount', # noqa: E501 + 'quantity': 'quantity', # noqa: E501 + 'unit_price': 'unit_price', # noqa: E501 + 'unit_of_measure': 'unit_of_measure', # noqa: E501 + 'discount_percentage': 'discount_percentage', # noqa: E501 + 'location_id': 'location_id', # noqa: E501 + 'department_id': 'department_id', # noqa: E501 + 'item': 'item', # noqa: E501 + 'ledger_account': 'ledger_account', # noqa: E501 + 'tax_rate': 'tax_rate', # noqa: E501 + 'row_version': 'row_version', # noqa: E501 + 'updated_by': 'updated_by', # noqa: E501 + 'created_by': 'created_by', # noqa: E501 + 'created_at': 'created_at', # noqa: E501 + 'updated_at': 'updated_at', # noqa: E501 + } + + read_only_vars = { + 'id', # noqa: E501 + 'updated_by', # noqa: E501 + 'created_by', # noqa: E501 + 'created_at', # noqa: E501 + 'updated_at', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """BillLineItem - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + row_id (str): Row ID. [optional] # noqa: E501 + code (str, none_type): User defined item code. [optional] # noqa: E501 + line_number (int, none_type): Line number in the invoice. [optional] # noqa: E501 + description (str, none_type): User defined description. [optional] # noqa: E501 + type (str, none_type): Bill Line Item type. [optional] # noqa: E501 + tax_amount (float, none_type): Tax amount. [optional] # noqa: E501 + total_amount (float, none_type): Total amount of the line item. [optional] # noqa: E501 + quantity (float, none_type): [optional] # noqa: E501 + unit_price (float, none_type): [optional] # noqa: E501 + unit_of_measure (str, none_type): Description of the unit type the item is sold as, ie: kg, hour.. [optional] # noqa: E501 + discount_percentage (float, none_type): Discount percentage. [optional] # noqa: E501 + location_id (str, none_type): Location id. [optional] # noqa: E501 + department_id (str, none_type): Department id. [optional] # noqa: E501 + item (LinkedInvoiceItem): [optional] # noqa: E501 + ledger_account (LinkedLedgerAccount): [optional] # noqa: E501 + tax_rate (LinkedTaxRate): [optional] # noqa: E501 + row_version (str, none_type): [optional] # noqa: E501 + updated_by (str, none_type): [optional] # noqa: E501 + created_by (str, none_type): [optional] # noqa: E501 + created_at (datetime): [optional] # noqa: E501 + updated_at (datetime): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """BillLineItem - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + row_id (str): Row ID. [optional] # noqa: E501 + code (str, none_type): User defined item code. [optional] # noqa: E501 + line_number (int, none_type): Line number in the invoice. [optional] # noqa: E501 + description (str, none_type): User defined description. [optional] # noqa: E501 + type (str, none_type): Bill Line Item type. [optional] # noqa: E501 + tax_amount (float, none_type): Tax amount. [optional] # noqa: E501 + total_amount (float, none_type): Total amount of the line item. [optional] # noqa: E501 + quantity (float, none_type): [optional] # noqa: E501 + unit_price (float, none_type): [optional] # noqa: E501 + unit_of_measure (str, none_type): Description of the unit type the item is sold as, ie: kg, hour.. [optional] # noqa: E501 + discount_percentage (float, none_type): Discount percentage. [optional] # noqa: E501 + location_id (str, none_type): Location id. [optional] # noqa: E501 + department_id (str, none_type): Department id. [optional] # noqa: E501 + item (LinkedInvoiceItem): [optional] # noqa: E501 + ledger_account (LinkedLedgerAccount): [optional] # noqa: E501 + tax_rate (LinkedTaxRate): [optional] # noqa: E501 + row_version (str, none_type): [optional] # noqa: E501 + updated_by (str, none_type): [optional] # noqa: E501 + created_by (str, none_type): [optional] # noqa: E501 + created_at (datetime): [optional] # noqa: E501 + updated_at (datetime): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/branch.py b/src/apideck/model/branch.py new file mode 100644 index 0000000000..cb2751acbc --- /dev/null +++ b/src/apideck/model/branch.py @@ -0,0 +1,260 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class Branch(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'id': (str,), # noqa: E501 + 'name': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'name': 'name', # noqa: E501 + } + + read_only_vars = { + 'id', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """Branch - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + name (str): Name of the branch.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """Branch - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + name (str): Name of the branch.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/cash_details.py b/src/apideck/model/cash_details.py new file mode 100644 index 0000000000..fb823328ac --- /dev/null +++ b/src/apideck/model/cash_details.py @@ -0,0 +1,259 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class CashDetails(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'amount': (bool, date, datetime, dict, float, int, list, str, none_type,), # noqa: E501 + 'charge_back_amount': (bool, date, datetime, dict, float, int, list, str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'amount': 'amount', # noqa: E501 + 'charge_back_amount': 'charge_back_amount', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """CashDetails - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + amount (bool, date, datetime, dict, float, int, list, str, none_type): The amount of cash given by the customer.. [optional] # noqa: E501 + charge_back_amount (bool, date, datetime, dict, float, int, list, str, none_type): The amount of change due back to the buyer. For Square: this read-only field is calculated from the amount_money and buyer_supplied_money fields.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """CashDetails - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + amount (bool, date, datetime, dict, float, int, list, str, none_type): The amount of cash given by the customer.. [optional] # noqa: E501 + charge_back_amount (bool, date, datetime, dict, float, int, list, str, none_type): The amount of change due back to the buyer. For Square: this read-only field is calculated from the amount_money and buyer_supplied_money fields.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/companies_filter.py b/src/apideck/model/companies_filter.py new file mode 100644 index 0000000000..472c226959 --- /dev/null +++ b/src/apideck/model/companies_filter.py @@ -0,0 +1,249 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class CompaniesFilter(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'name': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'name': 'name', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """CompaniesFilter - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + name (str): Name of the company to filter on. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """CompaniesFilter - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + name (str): Name of the company to filter on. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/companies_sort.py b/src/apideck/model/companies_sort.py new file mode 100644 index 0000000000..6fa9bc399e --- /dev/null +++ b/src/apideck/model/companies_sort.py @@ -0,0 +1,263 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.sort_direction import SortDirection + globals()['SortDirection'] = SortDirection + + +class CompaniesSort(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('by',): { + 'CREATED_AT': "created_at", + 'UPDATED_AT': "updated_at", + 'NAME': "name", + }, + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'by': (str,), # noqa: E501 + 'direction': (SortDirection,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'by': 'by', # noqa: E501 + 'direction': 'direction', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """CompaniesSort - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + by (str): The field on which to sort the Companies. [optional] # noqa: E501 + direction (SortDirection): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """CompaniesSort - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + by (str): The field on which to sort the Companies. [optional] # noqa: E501 + direction (SortDirection): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/company.py b/src/apideck/model/company.py new file mode 100644 index 0000000000..a3c300d4ee --- /dev/null +++ b/src/apideck/model/company.py @@ -0,0 +1,446 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.address import Address + from apideck.model.bank_account import BankAccount + from apideck.model.company_row_type import CompanyRowType + from apideck.model.currency import Currency + from apideck.model.custom_field import CustomField + from apideck.model.email import Email + from apideck.model.phone_number import PhoneNumber + from apideck.model.social_link import SocialLink + from apideck.model.tags import Tags + from apideck.model.website import Website + globals()['Address'] = Address + globals()['BankAccount'] = BankAccount + globals()['CompanyRowType'] = CompanyRowType + globals()['Currency'] = Currency + globals()['CustomField'] = CustomField + globals()['Email'] = Email + globals()['PhoneNumber'] = PhoneNumber + globals()['SocialLink'] = SocialLink + globals()['Tags'] = Tags + globals()['Website'] = Website + + +class Company(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + ('name',): { + 'min_length': 1, + }, + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'name': (str,), # noqa: E501 + 'id': (str,), # noqa: E501 + 'interaction_count': (int, none_type,), # noqa: E501 + 'owner_id': (str,), # noqa: E501 + 'image': (str, none_type,), # noqa: E501 + 'description': (str, none_type,), # noqa: E501 + 'vat_number': (str, none_type,), # noqa: E501 + 'currency': (Currency,), # noqa: E501 + 'status': (str, none_type,), # noqa: E501 + 'fax': (str, none_type,), # noqa: E501 + 'annual_revenue': (str, none_type,), # noqa: E501 + 'number_of_employees': (str, none_type,), # noqa: E501 + 'industry': (str, none_type,), # noqa: E501 + 'ownership': (str, none_type,), # noqa: E501 + 'sales_tax_number': (str, none_type,), # noqa: E501 + 'payee_number': (str, none_type,), # noqa: E501 + 'abn_or_tfn': (str, none_type,), # noqa: E501 + 'abn_branch': (str, none_type,), # noqa: E501 + 'acn': (str, none_type,), # noqa: E501 + 'first_name': (str, none_type,), # noqa: E501 + 'last_name': (str, none_type,), # noqa: E501 + 'parent_id': (str,), # noqa: E501 + 'bank_accounts': ([BankAccount],), # noqa: E501 + 'websites': ([Website],), # noqa: E501 + 'addresses': ([Address],), # noqa: E501 + 'social_links': ([SocialLink],), # noqa: E501 + 'phone_numbers': ([PhoneNumber],), # noqa: E501 + 'emails': ([Email],), # noqa: E501 + 'row_type': (CompanyRowType,), # noqa: E501 + 'custom_fields': ([CustomField],), # noqa: E501 + 'tags': (Tags,), # noqa: E501 + 'read_only': (bool, none_type,), # noqa: E501 + 'last_activity_at': (datetime, none_type,), # noqa: E501 + 'deleted': (bool,), # noqa: E501 + 'salutation': (str, none_type,), # noqa: E501 + 'birthday': (date, none_type,), # noqa: E501 + 'updated_by': (str, none_type,), # noqa: E501 + 'created_by': (str, none_type,), # noqa: E501 + 'updated_at': (datetime,), # noqa: E501 + 'created_at': (datetime,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'name': 'name', # noqa: E501 + 'id': 'id', # noqa: E501 + 'interaction_count': 'interaction_count', # noqa: E501 + 'owner_id': 'owner_id', # noqa: E501 + 'image': 'image', # noqa: E501 + 'description': 'description', # noqa: E501 + 'vat_number': 'vat_number', # noqa: E501 + 'currency': 'currency', # noqa: E501 + 'status': 'status', # noqa: E501 + 'fax': 'fax', # noqa: E501 + 'annual_revenue': 'annual_revenue', # noqa: E501 + 'number_of_employees': 'number_of_employees', # noqa: E501 + 'industry': 'industry', # noqa: E501 + 'ownership': 'ownership', # noqa: E501 + 'sales_tax_number': 'sales_tax_number', # noqa: E501 + 'payee_number': 'payee_number', # noqa: E501 + 'abn_or_tfn': 'abn_or_tfn', # noqa: E501 + 'abn_branch': 'abn_branch', # noqa: E501 + 'acn': 'acn', # noqa: E501 + 'first_name': 'first_name', # noqa: E501 + 'last_name': 'last_name', # noqa: E501 + 'parent_id': 'parent_id', # noqa: E501 + 'bank_accounts': 'bank_accounts', # noqa: E501 + 'websites': 'websites', # noqa: E501 + 'addresses': 'addresses', # noqa: E501 + 'social_links': 'social_links', # noqa: E501 + 'phone_numbers': 'phone_numbers', # noqa: E501 + 'emails': 'emails', # noqa: E501 + 'row_type': 'row_type', # noqa: E501 + 'custom_fields': 'custom_fields', # noqa: E501 + 'tags': 'tags', # noqa: E501 + 'read_only': 'read_only', # noqa: E501 + 'last_activity_at': 'last_activity_at', # noqa: E501 + 'deleted': 'deleted', # noqa: E501 + 'salutation': 'salutation', # noqa: E501 + 'birthday': 'birthday', # noqa: E501 + 'updated_by': 'updated_by', # noqa: E501 + 'created_by': 'created_by', # noqa: E501 + 'updated_at': 'updated_at', # noqa: E501 + 'created_at': 'created_at', # noqa: E501 + } + + read_only_vars = { + 'id', # noqa: E501 + 'interaction_count', # noqa: E501 + 'parent_id', # noqa: E501 + 'last_activity_at', # noqa: E501 + 'deleted', # noqa: E501 + 'updated_by', # noqa: E501 + 'created_by', # noqa: E501 + 'updated_at', # noqa: E501 + 'created_at', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, name, *args, **kwargs): # noqa: E501 + """Company - a model defined in OpenAPI + + Args: + name (str): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + interaction_count (int, none_type): [optional] # noqa: E501 + owner_id (str): [optional] # noqa: E501 + image (str, none_type): [optional] # noqa: E501 + description (str, none_type): [optional] # noqa: E501 + vat_number (str, none_type): VAT number. [optional] # noqa: E501 + currency (Currency): [optional] # noqa: E501 + status (str, none_type): [optional] # noqa: E501 + fax (str, none_type): [optional] # noqa: E501 + annual_revenue (str, none_type): Annual revenue. [optional] # noqa: E501 + number_of_employees (str, none_type): Number of employees. [optional] # noqa: E501 + industry (str, none_type): Industry. [optional] # noqa: E501 + ownership (str, none_type): Ownership. [optional] # noqa: E501 + sales_tax_number (str, none_type): [optional] # noqa: E501 + payee_number (str, none_type): [optional] # noqa: E501 + abn_or_tfn (str, none_type): An ABN is necessary for operating a business, while a TFN (Tax File Number) is required for any person working in Australia.. [optional] # noqa: E501 + abn_branch (str, none_type): An ABN Branch (also known as a GST Branch) is used if part of your business needs to account for GST separately from its parent entity.. [optional] # noqa: E501 + acn (str, none_type): The Australian Company Number (ACN) is a nine digit number with the last digit being a check digit calculated using a modified modulus 10 calculation. ASIC has adopted a convention of always printing and displaying the ACN in the format XXX XXX XXX; three blocks of three characters, each block separated by a blank.. [optional] # noqa: E501 + first_name (str, none_type): [optional] # noqa: E501 + last_name (str, none_type): [optional] # noqa: E501 + parent_id (str): Parent ID. [optional] # noqa: E501 + bank_accounts ([BankAccount]): [optional] # noqa: E501 + websites ([Website]): [optional] # noqa: E501 + addresses ([Address]): [optional] # noqa: E501 + social_links ([SocialLink]): [optional] # noqa: E501 + phone_numbers ([PhoneNumber]): [optional] # noqa: E501 + emails ([Email]): [optional] # noqa: E501 + row_type (CompanyRowType): [optional] # noqa: E501 + custom_fields ([CustomField]): [optional] # noqa: E501 + tags (Tags): [optional] # noqa: E501 + read_only (bool, none_type): [optional] # noqa: E501 + last_activity_at (datetime, none_type): [optional] # noqa: E501 + deleted (bool): [optional] # noqa: E501 + salutation (str, none_type): [optional] # noqa: E501 + birthday (date, none_type): [optional] # noqa: E501 + updated_by (str, none_type): [optional] # noqa: E501 + created_by (str, none_type): [optional] # noqa: E501 + updated_at (datetime): [optional] # noqa: E501 + created_at (datetime): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.name = name + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, name, *args, **kwargs): # noqa: E501 + """Company - a model defined in OpenAPI + + Args: + name (str): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + interaction_count (int, none_type): [optional] # noqa: E501 + owner_id (str): [optional] # noqa: E501 + image (str, none_type): [optional] # noqa: E501 + description (str, none_type): [optional] # noqa: E501 + vat_number (str, none_type): VAT number. [optional] # noqa: E501 + currency (Currency): [optional] # noqa: E501 + status (str, none_type): [optional] # noqa: E501 + fax (str, none_type): [optional] # noqa: E501 + annual_revenue (str, none_type): Annual revenue. [optional] # noqa: E501 + number_of_employees (str, none_type): Number of employees. [optional] # noqa: E501 + industry (str, none_type): Industry. [optional] # noqa: E501 + ownership (str, none_type): Ownership. [optional] # noqa: E501 + sales_tax_number (str, none_type): [optional] # noqa: E501 + payee_number (str, none_type): [optional] # noqa: E501 + abn_or_tfn (str, none_type): An ABN is necessary for operating a business, while a TFN (Tax File Number) is required for any person working in Australia.. [optional] # noqa: E501 + abn_branch (str, none_type): An ABN Branch (also known as a GST Branch) is used if part of your business needs to account for GST separately from its parent entity.. [optional] # noqa: E501 + acn (str, none_type): The Australian Company Number (ACN) is a nine digit number with the last digit being a check digit calculated using a modified modulus 10 calculation. ASIC has adopted a convention of always printing and displaying the ACN in the format XXX XXX XXX; three blocks of three characters, each block separated by a blank.. [optional] # noqa: E501 + first_name (str, none_type): [optional] # noqa: E501 + last_name (str, none_type): [optional] # noqa: E501 + parent_id (str): Parent ID. [optional] # noqa: E501 + bank_accounts ([BankAccount]): [optional] # noqa: E501 + websites ([Website]): [optional] # noqa: E501 + addresses ([Address]): [optional] # noqa: E501 + social_links ([SocialLink]): [optional] # noqa: E501 + phone_numbers ([PhoneNumber]): [optional] # noqa: E501 + emails ([Email]): [optional] # noqa: E501 + row_type (CompanyRowType): [optional] # noqa: E501 + custom_fields ([CustomField]): [optional] # noqa: E501 + tags (Tags): [optional] # noqa: E501 + read_only (bool, none_type): [optional] # noqa: E501 + last_activity_at (datetime, none_type): [optional] # noqa: E501 + deleted (bool): [optional] # noqa: E501 + salutation (str, none_type): [optional] # noqa: E501 + birthday (date, none_type): [optional] # noqa: E501 + updated_by (str, none_type): [optional] # noqa: E501 + created_by (str, none_type): [optional] # noqa: E501 + updated_at (datetime): [optional] # noqa: E501 + created_at (datetime): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.name = name + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/company_info.py b/src/apideck/model/company_info.py new file mode 100644 index 0000000000..f6b02102e2 --- /dev/null +++ b/src/apideck/model/company_info.py @@ -0,0 +1,365 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.address import Address + from apideck.model.currency import Currency + from apideck.model.email import Email + from apideck.model.linked_tax_rate import LinkedTaxRate + from apideck.model.phone_number import PhoneNumber + globals()['Address'] = Address + globals()['Currency'] = Currency + globals()['Email'] = Email + globals()['LinkedTaxRate'] = LinkedTaxRate + globals()['PhoneNumber'] = PhoneNumber + + +class CompanyInfo(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('status',): { + 'ACTIVE': "active", + 'INACTIVE': "inactive", + }, + ('fiscal_year_start_month',): { + 'JANUARY': "January", + 'FEBRUARY': "February", + 'MARCH': "March", + 'APRIL': "April", + 'MAY': "May", + 'JUNE': "June", + 'JULY': "July", + 'AUGUST': "August", + 'SEPTEMBER': "September", + 'OCTOBER': "October", + 'NOVEMBER': "November", + 'DECEMBER': "December", + }, + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'id': (str,), # noqa: E501 + 'company_name': (str, none_type,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'legal_name': (str,), # noqa: E501 + 'country': (str, none_type,), # noqa: E501 + 'sales_tax_number': (str, none_type,), # noqa: E501 + 'automated_sales_tax': (bool,), # noqa: E501 + 'sales_tax_enabled': (bool,), # noqa: E501 + 'default_sales_tax': (LinkedTaxRate,), # noqa: E501 + 'currency': (Currency,), # noqa: E501 + 'language': (str, none_type,), # noqa: E501 + 'fiscal_year_start_month': (str,), # noqa: E501 + 'company_start_date': (date,), # noqa: E501 + 'addresses': ([Address],), # noqa: E501 + 'phone_numbers': ([PhoneNumber],), # noqa: E501 + 'emails': ([Email],), # noqa: E501 + 'row_version': (str, none_type,), # noqa: E501 + 'updated_by': (str, none_type,), # noqa: E501 + 'created_by': (str, none_type,), # noqa: E501 + 'updated_at': (datetime,), # noqa: E501 + 'created_at': (datetime,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'company_name': 'company_name', # noqa: E501 + 'status': 'status', # noqa: E501 + 'legal_name': 'legal_name', # noqa: E501 + 'country': 'country', # noqa: E501 + 'sales_tax_number': 'sales_tax_number', # noqa: E501 + 'automated_sales_tax': 'automated_sales_tax', # noqa: E501 + 'sales_tax_enabled': 'sales_tax_enabled', # noqa: E501 + 'default_sales_tax': 'default_sales_tax', # noqa: E501 + 'currency': 'currency', # noqa: E501 + 'language': 'language', # noqa: E501 + 'fiscal_year_start_month': 'fiscal_year_start_month', # noqa: E501 + 'company_start_date': 'company_start_date', # noqa: E501 + 'addresses': 'addresses', # noqa: E501 + 'phone_numbers': 'phone_numbers', # noqa: E501 + 'emails': 'emails', # noqa: E501 + 'row_version': 'row_version', # noqa: E501 + 'updated_by': 'updated_by', # noqa: E501 + 'created_by': 'created_by', # noqa: E501 + 'updated_at': 'updated_at', # noqa: E501 + 'created_at': 'created_at', # noqa: E501 + } + + read_only_vars = { + 'id', # noqa: E501 + 'updated_by', # noqa: E501 + 'created_by', # noqa: E501 + 'updated_at', # noqa: E501 + 'created_at', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """CompanyInfo - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + company_name (str, none_type): [optional] # noqa: E501 + status (str): Based on the status some functionality is enabled or disabled.. [optional] # noqa: E501 + legal_name (str): The legal name of the company. [optional] # noqa: E501 + country (str, none_type): country code according to ISO 3166-1 alpha-2.. [optional] # noqa: E501 + sales_tax_number (str, none_type): [optional] # noqa: E501 + automated_sales_tax (bool): Whether sales tax is calculated automatically for the company. [optional] # noqa: E501 + sales_tax_enabled (bool): Whether sales tax is enabled for the company. [optional] # noqa: E501 + default_sales_tax (LinkedTaxRate): [optional] # noqa: E501 + currency (Currency): [optional] # noqa: E501 + language (str, none_type): language code according to ISO 639-1. For the United States - EN. [optional] # noqa: E501 + fiscal_year_start_month (str): The start month of fiscal year.. [optional] # noqa: E501 + company_start_date (date): Date when company file was created. [optional] # noqa: E501 + addresses ([Address]): [optional] # noqa: E501 + phone_numbers ([PhoneNumber]): [optional] # noqa: E501 + emails ([Email]): [optional] # noqa: E501 + row_version (str, none_type): [optional] # noqa: E501 + updated_by (str, none_type): [optional] # noqa: E501 + created_by (str, none_type): [optional] # noqa: E501 + updated_at (datetime): [optional] # noqa: E501 + created_at (datetime): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """CompanyInfo - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + company_name (str, none_type): [optional] # noqa: E501 + status (str): Based on the status some functionality is enabled or disabled.. [optional] # noqa: E501 + legal_name (str): The legal name of the company. [optional] # noqa: E501 + country (str, none_type): country code according to ISO 3166-1 alpha-2.. [optional] # noqa: E501 + sales_tax_number (str, none_type): [optional] # noqa: E501 + automated_sales_tax (bool): Whether sales tax is calculated automatically for the company. [optional] # noqa: E501 + sales_tax_enabled (bool): Whether sales tax is enabled for the company. [optional] # noqa: E501 + default_sales_tax (LinkedTaxRate): [optional] # noqa: E501 + currency (Currency): [optional] # noqa: E501 + language (str, none_type): language code according to ISO 639-1. For the United States - EN. [optional] # noqa: E501 + fiscal_year_start_month (str): The start month of fiscal year.. [optional] # noqa: E501 + company_start_date (date): Date when company file was created. [optional] # noqa: E501 + addresses ([Address]): [optional] # noqa: E501 + phone_numbers ([PhoneNumber]): [optional] # noqa: E501 + emails ([Email]): [optional] # noqa: E501 + row_version (str, none_type): [optional] # noqa: E501 + updated_by (str, none_type): [optional] # noqa: E501 + created_by (str, none_type): [optional] # noqa: E501 + updated_at (datetime): [optional] # noqa: E501 + created_at (datetime): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/company_row_type.py b/src/apideck/model/company_row_type.py new file mode 100644 index 0000000000..d6c54bde9b --- /dev/null +++ b/src/apideck/model/company_row_type.py @@ -0,0 +1,259 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class CompanyRowType(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'id': (str,), # noqa: E501 + 'name': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'name': 'name', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """CompanyRowType - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + name (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """CompanyRowType - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + name (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/compensation.py b/src/apideck/model/compensation.py new file mode 100644 index 0000000000..41a9fa457a --- /dev/null +++ b/src/apideck/model/compensation.py @@ -0,0 +1,281 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.benefit import Benefit + from apideck.model.deduction import Deduction + from apideck.model.tax import Tax + globals()['Benefit'] = Benefit + globals()['Deduction'] = Deduction + globals()['Tax'] = Tax + + +class Compensation(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'employee_id': (str,), # noqa: E501 + 'net_pay': (float,), # noqa: E501 + 'gross_pay': (float,), # noqa: E501 + 'taxes': ([Tax],), # noqa: E501 + 'deductions': ([Deduction],), # noqa: E501 + 'benefits': ([Benefit],), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'employee_id': 'employee_id', # noqa: E501 + 'net_pay': 'net_pay', # noqa: E501 + 'gross_pay': 'gross_pay', # noqa: E501 + 'taxes': 'taxes', # noqa: E501 + 'deductions': 'deductions', # noqa: E501 + 'benefits': 'benefits', # noqa: E501 + } + + read_only_vars = { + 'employee_id', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, employee_id, *args, **kwargs): # noqa: E501 + """Compensation - a model defined in OpenAPI + + Args: + employee_id (str): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + net_pay (float): The employee's net pay. Only available when payroll has been processed. [optional] # noqa: E501 + gross_pay (float): The employee's gross pay. Only available when payroll has been processed. [optional] # noqa: E501 + taxes ([Tax]): An array of employer and employee taxes for the pay period.. [optional] # noqa: E501 + deductions ([Deduction]): An array of employee deductions for the pay period.. [optional] # noqa: E501 + benefits ([Benefit]): An array of employee benefits for the pay period.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.employee_id = employee_id + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """Compensation - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + net_pay (float): The employee's net pay. Only available when payroll has been processed. [optional] # noqa: E501 + gross_pay (float): The employee's gross pay. Only available when payroll has been processed. [optional] # noqa: E501 + taxes ([Tax]): An array of employer and employee taxes for the pay period.. [optional] # noqa: E501 + deductions ([Deduction]): An array of employee deductions for the pay period.. [optional] # noqa: E501 + benefits ([Benefit]): An array of employee benefits for the pay period.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/connection.py b/src/apideck/model/connection.py new file mode 100644 index 0000000000..edf7296f16 --- /dev/null +++ b/src/apideck/model/connection.py @@ -0,0 +1,400 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.auth_type import AuthType + from apideck.model.connection_configuration import ConnectionConfiguration + from apideck.model.connection_state import ConnectionState + from apideck.model.form_field import FormField + from apideck.model.o_auth_grant_type import OAuthGrantType + from apideck.model.webhook_subscription import WebhookSubscription + globals()['AuthType'] = AuthType + globals()['ConnectionConfiguration'] = ConnectionConfiguration + globals()['ConnectionState'] = ConnectionState + globals()['FormField'] = FormField + globals()['OAuthGrantType'] = OAuthGrantType + globals()['WebhookSubscription'] = WebhookSubscription + + +class Connection(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('status',): { + 'LIVE': "live", + 'UPCOMING': "upcoming", + 'REQUESTED': "requested", + }, + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'id': (str,), # noqa: E501 + 'service_id': (str,), # noqa: E501 + 'name': (str,), # noqa: E501 + 'tag_line': (str,), # noqa: E501 + 'unified_api': (str,), # noqa: E501 + 'state': (ConnectionState,), # noqa: E501 + 'auth_type': (AuthType,), # noqa: E501 + 'oauth_grant_type': (OAuthGrantType,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'enabled': (bool,), # noqa: E501 + 'website': (str,), # noqa: E501 + 'icon': (str,), # noqa: E501 + 'logo': (str,), # noqa: E501 + 'authorize_url': (str, none_type,), # noqa: E501 + 'revoke_url': (str, none_type,), # noqa: E501 + 'settings': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type,), # noqa: E501 + 'metadata': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type,), # noqa: E501 + 'form_fields': ([FormField],), # noqa: E501 + 'configuration': ([ConnectionConfiguration],), # noqa: E501 + 'configurable_resources': ([str],), # noqa: E501 + 'resource_schema_support': ([str],), # noqa: E501 + 'resource_settings_support': ([str],), # noqa: E501 + 'settings_required_for_authorization': ([str],), # noqa: E501 + 'subscriptions': ([WebhookSubscription],), # noqa: E501 + 'has_guide': (bool,), # noqa: E501 + 'created_at': (float,), # noqa: E501 + 'updated_at': (float, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'service_id': 'service_id', # noqa: E501 + 'name': 'name', # noqa: E501 + 'tag_line': 'tag_line', # noqa: E501 + 'unified_api': 'unified_api', # noqa: E501 + 'state': 'state', # noqa: E501 + 'auth_type': 'auth_type', # noqa: E501 + 'oauth_grant_type': 'oauth_grant_type', # noqa: E501 + 'status': 'status', # noqa: E501 + 'enabled': 'enabled', # noqa: E501 + 'website': 'website', # noqa: E501 + 'icon': 'icon', # noqa: E501 + 'logo': 'logo', # noqa: E501 + 'authorize_url': 'authorize_url', # noqa: E501 + 'revoke_url': 'revoke_url', # noqa: E501 + 'settings': 'settings', # noqa: E501 + 'metadata': 'metadata', # noqa: E501 + 'form_fields': 'form_fields', # noqa: E501 + 'configuration': 'configuration', # noqa: E501 + 'configurable_resources': 'configurable_resources', # noqa: E501 + 'resource_schema_support': 'resource_schema_support', # noqa: E501 + 'resource_settings_support': 'resource_settings_support', # noqa: E501 + 'settings_required_for_authorization': 'settings_required_for_authorization', # noqa: E501 + 'subscriptions': 'subscriptions', # noqa: E501 + 'has_guide': 'has_guide', # noqa: E501 + 'created_at': 'created_at', # noqa: E501 + 'updated_at': 'updated_at', # noqa: E501 + } + + read_only_vars = { + 'id', # noqa: E501 + 'service_id', # noqa: E501 + 'name', # noqa: E501 + 'tag_line', # noqa: E501 + 'unified_api', # noqa: E501 + 'status', # noqa: E501 + 'website', # noqa: E501 + 'icon', # noqa: E501 + 'logo', # noqa: E501 + 'authorize_url', # noqa: E501 + 'revoke_url', # noqa: E501 + 'form_fields', # noqa: E501 + 'configurable_resources', # noqa: E501 + 'resource_schema_support', # noqa: E501 + 'resource_settings_support', # noqa: E501 + 'settings_required_for_authorization', # noqa: E501 + 'subscriptions', # noqa: E501 + 'has_guide', # noqa: E501 + 'created_at', # noqa: E501 + 'updated_at', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """Connection - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): The unique identifier of the connection.. [optional] # noqa: E501 + service_id (str): The ID of the service this connection belongs to.. [optional] # noqa: E501 + name (str): The name of the connection. [optional] # noqa: E501 + tag_line (str): [optional] # noqa: E501 + unified_api (str): The unified API category where the connection belongs to.. [optional] # noqa: E501 + state (ConnectionState): [optional] # noqa: E501 + auth_type (AuthType): [optional] # noqa: E501 + oauth_grant_type (OAuthGrantType): [optional] # noqa: E501 + status (str): Status of the connection.. [optional] # noqa: E501 + enabled (bool): Whether the connection is enabled or not. You can enable or disable a connection using the Update Connection API.. [optional] # noqa: E501 + website (str): The website URL of the connection. [optional] # noqa: E501 + icon (str): A visual icon of the connection, that will be shown in the Vault. [optional] # noqa: E501 + logo (str): The logo of the connection, that will be shown in the Vault. [optional] # noqa: E501 + authorize_url (str, none_type): The OAuth redirect URI. Redirect your users to this URI to let them authorize your app in the connector's UI. Before you can use this URI, you must add `redirect_uri` as a query parameter. Your users will be redirected to this `redirect_uri` after they granted access to your app in the connector's UI.. [optional] # noqa: E501 + revoke_url (str, none_type): The OAuth revoke URI. Redirect your users to this URI to revoke this connection. Before you can use this URI, you must add `redirect_uri` as a query parameter. Your users will be redirected to this `redirect_uri` after they granted access to your app in the connector's UI.. [optional] # noqa: E501 + settings ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Connection settings. Values will persist to `form_fields` with corresponding id. [optional] # noqa: E501 + metadata ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Attach your own consumer specific metadata. [optional] # noqa: E501 + form_fields ([FormField]): The settings that are wanted to create a connection.. [optional] # noqa: E501 + configuration ([ConnectionConfiguration]): [optional] # noqa: E501 + configurable_resources ([str]): [optional] # noqa: E501 + resource_schema_support ([str]): [optional] # noqa: E501 + resource_settings_support ([str]): [optional] # noqa: E501 + settings_required_for_authorization ([str]): List of settings that are required to be configured on integration before authorization can occur. [optional] # noqa: E501 + subscriptions ([WebhookSubscription]): [optional] # noqa: E501 + has_guide (bool): Whether the connector has a guide available in the developer docs or not (https://docs.apideck.com/connectors/{service_id}/docs/consumer+connection).. [optional] # noqa: E501 + created_at (float): [optional] # noqa: E501 + updated_at (float, none_type): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """Connection - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): The unique identifier of the connection.. [optional] # noqa: E501 + service_id (str): The ID of the service this connection belongs to.. [optional] # noqa: E501 + name (str): The name of the connection. [optional] # noqa: E501 + tag_line (str): [optional] # noqa: E501 + unified_api (str): The unified API category where the connection belongs to.. [optional] # noqa: E501 + state (ConnectionState): [optional] # noqa: E501 + auth_type (AuthType): [optional] # noqa: E501 + oauth_grant_type (OAuthGrantType): [optional] # noqa: E501 + status (str): Status of the connection.. [optional] # noqa: E501 + enabled (bool): Whether the connection is enabled or not. You can enable or disable a connection using the Update Connection API.. [optional] # noqa: E501 + website (str): The website URL of the connection. [optional] # noqa: E501 + icon (str): A visual icon of the connection, that will be shown in the Vault. [optional] # noqa: E501 + logo (str): The logo of the connection, that will be shown in the Vault. [optional] # noqa: E501 + authorize_url (str, none_type): The OAuth redirect URI. Redirect your users to this URI to let them authorize your app in the connector's UI. Before you can use this URI, you must add `redirect_uri` as a query parameter. Your users will be redirected to this `redirect_uri` after they granted access to your app in the connector's UI.. [optional] # noqa: E501 + revoke_url (str, none_type): The OAuth revoke URI. Redirect your users to this URI to revoke this connection. Before you can use this URI, you must add `redirect_uri` as a query parameter. Your users will be redirected to this `redirect_uri` after they granted access to your app in the connector's UI.. [optional] # noqa: E501 + settings ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Connection settings. Values will persist to `form_fields` with corresponding id. [optional] # noqa: E501 + metadata ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Attach your own consumer specific metadata. [optional] # noqa: E501 + form_fields ([FormField]): The settings that are wanted to create a connection.. [optional] # noqa: E501 + configuration ([ConnectionConfiguration]): [optional] # noqa: E501 + configurable_resources ([str]): [optional] # noqa: E501 + resource_schema_support ([str]): [optional] # noqa: E501 + resource_settings_support ([str]): [optional] # noqa: E501 + settings_required_for_authorization ([str]): List of settings that are required to be configured on integration before authorization can occur. [optional] # noqa: E501 + subscriptions ([WebhookSubscription]): [optional] # noqa: E501 + has_guide (bool): Whether the connector has a guide available in the developer docs or not (https://docs.apideck.com/connectors/{service_id}/docs/consumer+connection).. [optional] # noqa: E501 + created_at (float): [optional] # noqa: E501 + updated_at (float, none_type): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/connection_configuration.py b/src/apideck/model/connection_configuration.py new file mode 100644 index 0000000000..35ba7587d2 --- /dev/null +++ b/src/apideck/model/connection_configuration.py @@ -0,0 +1,265 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.connection_defaults import ConnectionDefaults + globals()['ConnectionDefaults'] = ConnectionDefaults + + +class ConnectionConfiguration(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'resource': (str,), # noqa: E501 + 'defaults': ([ConnectionDefaults],), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'resource': 'resource', # noqa: E501 + 'defaults': 'defaults', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ConnectionConfiguration - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + resource (str): [optional] # noqa: E501 + defaults ([ConnectionDefaults]): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """ConnectionConfiguration - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + resource (str): [optional] # noqa: E501 + defaults ([ConnectionDefaults]): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/connection_defaults.py b/src/apideck/model/connection_defaults.py new file mode 100644 index 0000000000..6657fa4a07 --- /dev/null +++ b/src/apideck/model/connection_defaults.py @@ -0,0 +1,278 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.form_field_option import FormFieldOption + globals()['FormFieldOption'] = FormFieldOption + + +class ConnectionDefaults(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('target',): { + 'CUSTOM_FIELDS': "custom_fields", + 'RESOURCE': "resource", + }, + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'target': (str,), # noqa: E501 + 'id': (str,), # noqa: E501 + 'options': ([FormFieldOption],), # noqa: E501 + 'value': (bool, date, datetime, dict, float, int, list, str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'target': 'target', # noqa: E501 + 'id': 'id', # noqa: E501 + 'options': 'options', # noqa: E501 + 'value': 'value', # noqa: E501 + } + + read_only_vars = { + 'target', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ConnectionDefaults - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + target (str): [optional] # noqa: E501 + id (str): [optional] # noqa: E501 + options ([FormFieldOption]): [optional] # noqa: E501 + value (bool, date, datetime, dict, float, int, list, str, none_type): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """ConnectionDefaults - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + target (str): [optional] # noqa: E501 + id (str): [optional] # noqa: E501 + options ([FormFieldOption]): [optional] # noqa: E501 + value (bool, date, datetime, dict, float, int, list, str, none_type): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/connection_import_data.py b/src/apideck/model/connection_import_data.py new file mode 100644 index 0000000000..0d81f7951e --- /dev/null +++ b/src/apideck/model/connection_import_data.py @@ -0,0 +1,269 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.connection_import_data_credentials import ConnectionImportDataCredentials + globals()['ConnectionImportDataCredentials'] = ConnectionImportDataCredentials + + +class ConnectionImportData(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'credentials': (ConnectionImportDataCredentials,), # noqa: E501 + 'settings': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type,), # noqa: E501 + 'metadata': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'credentials': 'credentials', # noqa: E501 + 'settings': 'settings', # noqa: E501 + 'metadata': 'metadata', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ConnectionImportData - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + credentials (ConnectionImportDataCredentials): [optional] # noqa: E501 + settings ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Connection settings. Values will persist to `form_fields` with corresponding id. [optional] # noqa: E501 + metadata ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Attach your own consumer specific metadata. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """ConnectionImportData - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + credentials (ConnectionImportDataCredentials): [optional] # noqa: E501 + settings ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Connection settings. Values will persist to `form_fields` with corresponding id. [optional] # noqa: E501 + metadata ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Attach your own consumer specific metadata. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/connection_import_data_credentials.py b/src/apideck/model/connection_import_data_credentials.py new file mode 100644 index 0000000000..e6d711801a --- /dev/null +++ b/src/apideck/model/connection_import_data_credentials.py @@ -0,0 +1,273 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class ConnectionImportDataCredentials(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'refresh_token': (str,), # noqa: E501 + 'access_token': (str,), # noqa: E501 + 'issued_at': (datetime, none_type,), # noqa: E501 + 'expires_in': (int, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'refresh_token': 'refresh_token', # noqa: E501 + 'access_token': 'access_token', # noqa: E501 + 'issued_at': 'issued_at', # noqa: E501 + 'expires_in': 'expires_in', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, refresh_token, *args, **kwargs): # noqa: E501 + """ConnectionImportDataCredentials - a model defined in OpenAPI + + Args: + refresh_token (str): The refresh token can be used to obtain a new access token. + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + access_token (str): Access token. [optional] # noqa: E501 + issued_at (datetime, none_type): The datetime at which the token was issued. If omitted the token will be queued for refresh.. [optional] # noqa: E501 + expires_in (int, none_type): The number of seconds until the token expires. If omitted the token will be queued for refresh.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.refresh_token = refresh_token + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, refresh_token, *args, **kwargs): # noqa: E501 + """ConnectionImportDataCredentials - a model defined in OpenAPI + + Args: + refresh_token (str): The refresh token can be used to obtain a new access token. + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + access_token (str): Access token. [optional] # noqa: E501 + issued_at (datetime, none_type): The datetime at which the token was issued. If omitted the token will be queued for refresh.. [optional] # noqa: E501 + expires_in (int, none_type): The number of seconds until the token expires. If omitted the token will be queued for refresh.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.refresh_token = refresh_token + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/connection_metadata.py b/src/apideck/model/connection_metadata.py new file mode 100644 index 0000000000..6599777f01 --- /dev/null +++ b/src/apideck/model/connection_metadata.py @@ -0,0 +1,259 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class ConnectionMetadata(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'id': (str,), # noqa: E501 + 'name': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'name': 'name', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ConnectionMetadata - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + name (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """ConnectionMetadata - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + name (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/connection_state.py b/src/apideck/model/connection_state.py new file mode 100644 index 0000000000..970ccc60e5 --- /dev/null +++ b/src/apideck/model/connection_state.py @@ -0,0 +1,284 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class ConnectionState(ModelSimple): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('value',): { + 'AVAILABLE': "available", + 'CALLABLE': "callable", + 'ADDED': "added", + 'AUTHORIZED': "authorized", + }, + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'value': (str,), + } + + @cached_property + def discriminator(): + return None + + + attribute_map = {} + + read_only_vars = set() + + _composed_schemas = None + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): + """ConnectionState - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] (str): [Connection state flow](#section/Connection-state)., must be one of ["available", "callable", "added", "authorized", ] # noqa: E501 + + Keyword Args: + value (str): [Connection state flow](#section/Connection-state)., must be one of ["available", "callable", "added", "authorized", ] # noqa: E501 + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + self.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): + """ConnectionState - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] (str): [Connection state flow](#section/Connection-state)., must be one of ["available", "callable", "added", "authorized", ] # noqa: E501 + + Keyword Args: + value (str): [Connection state flow](#section/Connection-state)., must be one of ["available", "callable", "added", "authorized", ] # noqa: E501 + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + self.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + return self diff --git a/src/apideck/model/connection_webhook.py b/src/apideck/model/connection_webhook.py new file mode 100644 index 0000000000..9371273d5c --- /dev/null +++ b/src/apideck/model/connection_webhook.py @@ -0,0 +1,409 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_api_id import UnifiedApiId + globals()['UnifiedApiId'] = UnifiedApiId + + +class ConnectionWebhook(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('status',): { + 'ENABLED': "enabled", + 'DISABLED': "disabled", + }, + ('events',): { + '*': "*", + 'CRM.ACTIVITY.CREATED': "crm.activity.created", + 'CRM.ACTIVITY.UPDATED': "crm.activity.updated", + 'CRM.ACTIVITY.DELETED': "crm.activity.deleted", + 'CRM.COMPANY.CREATED': "crm.company.created", + 'CRM.COMPANY.UPDATED': "crm.company.updated", + 'CRM.COMPANY.DELETED': "crm.company.deleted", + 'CRM.CONTACT.CREATED': "crm.contact.created", + 'CRM.CONTACT.UPDATED': "crm.contact.updated", + 'CRM.CONTACT.DELETED': "crm.contact.deleted", + 'CRM.LEAD.CREATED': "crm.lead.created", + 'CRM.LEAD.UPDATED': "crm.lead.updated", + 'CRM.LEAD.DELETED': "crm.lead.deleted", + 'CRM.NOTE.CREATED': "crm.note.created", + 'CRM.NOTES.UPDATED': "crm.notes.updated", + 'CRM.NOTES.DELETED': "crm.notes.deleted", + 'CRM.OPPORTUNITY.CREATED': "crm.opportunity.created", + 'CRM.OPPORTUNITY.UPDATED': "crm.opportunity.updated", + 'CRM.OPPORTUNITY.DELETED': "crm.opportunity.deleted", + 'LEAD.LEAD.CREATED': "lead.lead.created", + 'LEAD.LEAD.UPDATED': "lead.lead.updated", + 'LEAD.LEAD.DELETED': "lead.lead.deleted", + 'VAULT.CONNECTION.CREATED': "vault.connection.created", + 'VAULT.CONNECTION.UPDATED': "vault.connection.updated", + 'VAULT.CONNECTION.DISABLED': "vault.connection.disabled", + 'VAULT.CONNECTION.DELETED': "vault.connection.deleted", + 'VAULT.CONNECTION.CALLABLE': "vault.connection.callable", + 'VAULT.CONNECTION.TOKEN_REFRESH.FAILED': "vault.connection.token_refresh.failed", + 'ATS.JOB.CREATED': "ats.job.created", + 'ATS.JOB.UPDATED': "ats.job.updated", + 'ATS.JOB.DELETED': "ats.job.deleted", + 'ATS.APPLICANT.CREATED': "ats.applicant.created", + 'ATS.APPLICANT.UPDATED': "ats.applicant.updated", + 'ATS.APPLICANT.DELETED': "ats.applicant.deleted", + 'ACCOUNTING.CUSTOMER.CREATED': "accounting.customer.created", + 'ACCOUNTING.CUSTOMER.UPDATED': "accounting.customer.updated", + 'ACCOUNTING.CUSTOMER.DELETED': "accounting.customer.deleted", + 'ACCOUNTING.INVOICE.CREATED': "accounting.invoice.created", + 'ACCOUNTING.INVOICE.UPDATED': "accounting.invoice.updated", + 'ACCOUNTING.INVOICE.DELETED': "accounting.invoice.deleted", + 'ACCOUNTING.INVOICE_ITEM.CREATED': "accounting.invoice_item.created", + 'ACCOUNTING.INVOICE_ITEM.UPDATED': "accounting.invoice_item.updated", + 'ACCOUNTING.INVOICE_ITEM.DELETED': "accounting.invoice_item.deleted", + 'ACCOUNTING.LEDGER_ACCOUNT.CREATED': "accounting.ledger_account.created", + 'ACCOUNTING.LEDGER_ACCOUNT.UPDATED': "accounting.ledger_account.updated", + 'ACCOUNTING.LEDGER_ACCOUNT.DELETED': "accounting.ledger_account.deleted", + 'ACCOUNTING.TAX_RATE.CREATED': "accounting.tax_rate.created", + 'ACCOUNTING.TAX_RATE.UPDATED': "accounting.tax_rate.updated", + 'ACCOUNTING.TAX_RATE.DELETED': "accounting.tax_rate.deleted", + 'ACCOUNTING.BILL.CREATED': "accounting.bill.created", + 'ACCOUNTING.BILL.UPDATED': "accounting.bill.updated", + 'ACCOUNTING.BILL.DELETED': "accounting.bill.deleted", + 'ACCOUNTING.PAYMENT.CREATED': "accounting.payment.created", + 'ACCOUNTING.PAYMENT.UPDATED': "accounting.payment.updated", + 'ACCOUNTING.PAYMENT.DELETED': "accounting.payment.deleted", + 'ACCOUNTING.SUPPLIER.CREATED': "accounting.supplier.created", + 'ACCOUNTING.SUPPLIER.UPDATED': "accounting.supplier.updated", + 'ACCOUNTING.SUPPLIER.DELETED': "accounting.supplier.deleted", + 'POS.ORDER.CREATED': "pos.order.created", + 'POS.ORDER.UPDATED': "pos.order.updated", + 'POS.ORDER.DELETED': "pos.order.deleted", + 'POS.PRODUCT.CREATED': "pos.product.created", + 'POS.PRODUCT.UPDATED': "pos.product.updated", + 'POS.PRODUCT.DELETED': "pos.product.deleted", + 'POS.PAYMENT.CREATED': "pos.payment.created", + 'POS.PAYMENT.UPDATED': "pos.payment.updated", + 'POS.PAYMENT.DELETED': "pos.payment.deleted", + 'POS.MERCHANT.CREATED': "pos.merchant.created", + 'POS.MERCHANT.UPDATED': "pos.merchant.updated", + 'POS.MERCHANT.DELETED': "pos.merchant.deleted", + 'POS.LOCATION.CREATED': "pos.location.created", + 'POS.LOCATION.UPDATED': "pos.location.updated", + 'POS.LOCATION.DELETED': "pos.location.deleted", + 'POS.ITEM.CREATED': "pos.item.created", + 'POS.ITEM.UPDATED': "pos.item.updated", + 'POS.ITEM.DELETED': "pos.item.deleted", + 'POS.MODIFIER.CREATED': "pos.modifier.created", + 'POS.MODIFIER.UPDATED': "pos.modifier.updated", + 'POS.MODIFIER.DELETED': "pos.modifier.deleted", + 'POS.MODIFIER-GROUP.CREATED': "pos.modifier-group.created", + 'POS.MODIFIER-GROUP.UPDATED': "pos.modifier-group.updated", + 'POS.MODIFIER-GROUP.DELETED': "pos.modifier-group.deleted", + 'HRIS.EMPLOYEE.CREATED': "hris.employee.created", + 'HRIS.EMPLOYEE.UPDATED': "hris.employee.updated", + 'HRIS.EMPLOYEE.DELETED': "hris.employee.deleted", + 'HRIS.COMPANY.CREATED': "hris.company.created", + 'HRIS.COMPANY.UPDATED': "hris.company.updated", + 'HRIS.COMPANY.DELETED': "hris.company.deleted", + 'FILE-STORAGE.FILE.CREATED': "file-storage.file.created", + 'FILE-STORAGE.FILE.UPDATED': "file-storage.file.updated", + 'FILE-STORAGE.FILE.DELETED': "file-storage.file.deleted", + }, + } + + validations = { + ('delivery_url',): { + 'regex': { + 'pattern': r'^(https?):\/\/', # noqa: E501 + }, + }, + ('execute_base_url',): { + 'regex': { + 'pattern': r'^(https?):\/\/', # noqa: E501 + }, + }, + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'unified_api': (UnifiedApiId,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'delivery_url': (str,), # noqa: E501 + 'execute_base_url': (str,), # noqa: E501 + 'events': ([str],), # noqa: E501 + 'id': (str,), # noqa: E501 + 'description': (str, none_type,), # noqa: E501 + 'updated_at': (datetime,), # noqa: E501 + 'created_at': (datetime,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'unified_api': 'unified_api', # noqa: E501 + 'status': 'status', # noqa: E501 + 'delivery_url': 'delivery_url', # noqa: E501 + 'execute_base_url': 'execute_base_url', # noqa: E501 + 'events': 'events', # noqa: E501 + 'id': 'id', # noqa: E501 + 'description': 'description', # noqa: E501 + 'updated_at': 'updated_at', # noqa: E501 + 'created_at': 'created_at', # noqa: E501 + } + + read_only_vars = { + 'execute_base_url', # noqa: E501 + 'id', # noqa: E501 + 'updated_at', # noqa: E501 + 'created_at', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, unified_api, status, delivery_url, execute_base_url, events, *args, **kwargs): # noqa: E501 + """ConnectionWebhook - a model defined in OpenAPI + + Args: + unified_api (UnifiedApiId): + status (str): The status of the webhook. + delivery_url (str): The delivery url of the webhook endpoint. + execute_base_url (str): The Unify Base URL events from connectors will be sent to after service id is appended. + events ([str]): The list of subscribed events for this webhook. [`*`] indicates that all events are enabled. + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + description (str, none_type): [optional] # noqa: E501 + updated_at (datetime): [optional] # noqa: E501 + created_at (datetime): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.unified_api = unified_api + self.status = status + self.delivery_url = delivery_url + self.execute_base_url = execute_base_url + self.events = events + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, unified_api, status, delivery_url, events, *args, **kwargs): # noqa: E501 + """ConnectionWebhook - a model defined in OpenAPI + + Args: + unified_api (UnifiedApiId): + status (str): The status of the webhook. + delivery_url (str): The delivery url of the webhook endpoint. + events ([str]): The list of subscribed events for this webhook. [`*`] indicates that all events are enabled. + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + description (str, none_type): [optional] # noqa: E501 + updated_at (datetime): [optional] # noqa: E501 + created_at (datetime): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.unified_api = unified_api + self.status = status + self.delivery_url = delivery_url + self.events = events + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/connector.py b/src/apideck/model/connector.py new file mode 100644 index 0000000000..fef77abb0b --- /dev/null +++ b/src/apideck/model/connector.py @@ -0,0 +1,400 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.connector_doc import ConnectorDoc + from apideck.model.connector_event import ConnectorEvent + from apideck.model.connector_oauth_scopes import ConnectorOauthScopes + from apideck.model.connector_setting import ConnectorSetting + from apideck.model.connector_status import ConnectorStatus + from apideck.model.connector_tls_support import ConnectorTlsSupport + from apideck.model.connector_unified_apis import ConnectorUnifiedApis + from apideck.model.linked_connector_resource import LinkedConnectorResource + from apideck.model.webhook_support import WebhookSupport + globals()['ConnectorDoc'] = ConnectorDoc + globals()['ConnectorEvent'] = ConnectorEvent + globals()['ConnectorOauthScopes'] = ConnectorOauthScopes + globals()['ConnectorSetting'] = ConnectorSetting + globals()['ConnectorStatus'] = ConnectorStatus + globals()['ConnectorTlsSupport'] = ConnectorTlsSupport + globals()['ConnectorUnifiedApis'] = ConnectorUnifiedApis + globals()['LinkedConnectorResource'] = LinkedConnectorResource + globals()['WebhookSupport'] = WebhookSupport + + +class Connector(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('auth_type',): { + 'OAUTH2': "oauth2", + 'APIKEY': "apiKey", + 'BASIC': "basic", + 'CUSTOM': "custom", + 'NONE': "none", + }, + ('oauth_grant_type',): { + 'AUTHORIZATION_CODE': "authorization_code", + 'CLIENT_CREDENTIALS': "client_credentials", + 'PASSWORD': "password", + }, + ('oauth_credentials_source',): { + 'INTEGRATION': "integration", + 'CONNECTION': "connection", + }, + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'id': (str,), # noqa: E501 + 'name': (str,), # noqa: E501 + 'status': (ConnectorStatus,), # noqa: E501 + 'description': (str, none_type,), # noqa: E501 + 'icon_url': (str,), # noqa: E501 + 'logo_url': (str,), # noqa: E501 + 'website_url': (str,), # noqa: E501 + 'signup_url': (str,), # noqa: E501 + 'free_trial_available': (bool,), # noqa: E501 + 'auth_type': (str,), # noqa: E501 + 'auth_only': (bool,), # noqa: E501 + 'blind_mapped': (bool,), # noqa: E501 + 'oauth_grant_type': (str,), # noqa: E501 + 'oauth_credentials_source': (str,), # noqa: E501 + 'oauth_scopes': ([ConnectorOauthScopes],), # noqa: E501 + 'custom_scopes': (bool,), # noqa: E501 + 'has_sandbox_credentials': (bool,), # noqa: E501 + 'settings': ([ConnectorSetting],), # noqa: E501 + 'service_id': (str,), # noqa: E501 + 'unified_apis': ([ConnectorUnifiedApis],), # noqa: E501 + 'supported_resources': ([LinkedConnectorResource],), # noqa: E501 + 'configurable_resources': ([str],), # noqa: E501 + 'supported_events': ([ConnectorEvent],), # noqa: E501 + 'webhook_support': ([WebhookSupport],), # noqa: E501 + 'docs': ([ConnectorDoc],), # noqa: E501 + 'tls_support': (ConnectorTlsSupport,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'name': 'name', # noqa: E501 + 'status': 'status', # noqa: E501 + 'description': 'description', # noqa: E501 + 'icon_url': 'icon_url', # noqa: E501 + 'logo_url': 'logo_url', # noqa: E501 + 'website_url': 'website_url', # noqa: E501 + 'signup_url': 'signup_url', # noqa: E501 + 'free_trial_available': 'free_trial_available', # noqa: E501 + 'auth_type': 'auth_type', # noqa: E501 + 'auth_only': 'auth_only', # noqa: E501 + 'blind_mapped': 'blind_mapped', # noqa: E501 + 'oauth_grant_type': 'oauth_grant_type', # noqa: E501 + 'oauth_credentials_source': 'oauth_credentials_source', # noqa: E501 + 'oauth_scopes': 'oauth_scopes', # noqa: E501 + 'custom_scopes': 'custom_scopes', # noqa: E501 + 'has_sandbox_credentials': 'has_sandbox_credentials', # noqa: E501 + 'settings': 'settings', # noqa: E501 + 'service_id': 'service_id', # noqa: E501 + 'unified_apis': 'unified_apis', # noqa: E501 + 'supported_resources': 'supported_resources', # noqa: E501 + 'configurable_resources': 'configurable_resources', # noqa: E501 + 'supported_events': 'supported_events', # noqa: E501 + 'webhook_support': 'webhook_support', # noqa: E501 + 'docs': 'docs', # noqa: E501 + 'tls_support': 'tls_support', # noqa: E501 + } + + read_only_vars = { + 'id', # noqa: E501 + 'auth_type', # noqa: E501 + 'auth_only', # noqa: E501 + 'blind_mapped', # noqa: E501 + 'oauth_grant_type', # noqa: E501 + 'oauth_credentials_source', # noqa: E501 + 'custom_scopes', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """Connector - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): ID of the connector.. [optional] # noqa: E501 + name (str): Name of the connector.. [optional] # noqa: E501 + status (ConnectorStatus): [optional] # noqa: E501 + description (str, none_type): [optional] # noqa: E501 + icon_url (str): Link to a small square icon for the connector.. [optional] # noqa: E501 + logo_url (str): Link to the full logo for the connector.. [optional] # noqa: E501 + website_url (str): Link to the connector's website.. [optional] # noqa: E501 + signup_url (str): Link to the connector's signup page.. [optional] # noqa: E501 + free_trial_available (bool): Set to `true` when the connector offers a free trial. Use `signup_url` to sign up for a free trial. [optional] # noqa: E501 + auth_type (str): Type of authorization used by the connector. [optional] # noqa: E501 + auth_only (bool): Indicates whether a connector only supports authentication. In this case the connector is not mapped to a Unified API, but can be used with the Proxy API. [optional] # noqa: E501 + blind_mapped (bool): Set to `true` when connector was implemented from downstream docs only and without API access. This state indicates that integration will require Apideck support, and access to downstream API to validate mapping quality.. [optional] # noqa: E501 + oauth_grant_type (str): OAuth grant type used by the connector. More info: https://oauth.net/2/grant-types. [optional] # noqa: E501 + oauth_credentials_source (str): Location of the OAuth client credentials. For most connectors the OAuth client credentials are stored on integration and managed by the application owner. For others they are stored on connection and managed by the consumer in Vault.. [optional] # noqa: E501 + oauth_scopes ([ConnectorOauthScopes]): List of OAuth Scopes available for this connector.. [optional] # noqa: E501 + custom_scopes (bool): Set to `true` when connector allows the definition of custom scopes.. [optional] # noqa: E501 + has_sandbox_credentials (bool): Indicates whether Apideck Sandbox OAuth credentials are available.. [optional] # noqa: E501 + settings ([ConnectorSetting]): [optional] # noqa: E501 + service_id (str): Service provider identifier. [optional] # noqa: E501 + unified_apis ([ConnectorUnifiedApis]): List of Unified APIs that feature this connector.. [optional] # noqa: E501 + supported_resources ([LinkedConnectorResource]): List of resources that are supported on the connector.. [optional] # noqa: E501 + configurable_resources ([str]): List of resources that have settings that can be configured.. [optional] # noqa: E501 + supported_events ([ConnectorEvent]): List of events that are supported on the connector across all Unified APIs.. [optional] # noqa: E501 + webhook_support ([WebhookSupport]): How webhooks are supported for the connector. Sometimes the connector natively supports webhooks, other times Apideck virtualizes them based on polling.. [optional] # noqa: E501 + docs ([ConnectorDoc]): [optional] # noqa: E501 + tls_support (ConnectorTlsSupport): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """Connector - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): ID of the connector.. [optional] # noqa: E501 + name (str): Name of the connector.. [optional] # noqa: E501 + status (ConnectorStatus): [optional] # noqa: E501 + description (str, none_type): [optional] # noqa: E501 + icon_url (str): Link to a small square icon for the connector.. [optional] # noqa: E501 + logo_url (str): Link to the full logo for the connector.. [optional] # noqa: E501 + website_url (str): Link to the connector's website.. [optional] # noqa: E501 + signup_url (str): Link to the connector's signup page.. [optional] # noqa: E501 + free_trial_available (bool): Set to `true` when the connector offers a free trial. Use `signup_url` to sign up for a free trial. [optional] # noqa: E501 + auth_type (str): Type of authorization used by the connector. [optional] # noqa: E501 + auth_only (bool): Indicates whether a connector only supports authentication. In this case the connector is not mapped to a Unified API, but can be used with the Proxy API. [optional] # noqa: E501 + blind_mapped (bool): Set to `true` when connector was implemented from downstream docs only and without API access. This state indicates that integration will require Apideck support, and access to downstream API to validate mapping quality.. [optional] # noqa: E501 + oauth_grant_type (str): OAuth grant type used by the connector. More info: https://oauth.net/2/grant-types. [optional] # noqa: E501 + oauth_credentials_source (str): Location of the OAuth client credentials. For most connectors the OAuth client credentials are stored on integration and managed by the application owner. For others they are stored on connection and managed by the consumer in Vault.. [optional] # noqa: E501 + oauth_scopes ([ConnectorOauthScopes]): List of OAuth Scopes available for this connector.. [optional] # noqa: E501 + custom_scopes (bool): Set to `true` when connector allows the definition of custom scopes.. [optional] # noqa: E501 + has_sandbox_credentials (bool): Indicates whether Apideck Sandbox OAuth credentials are available.. [optional] # noqa: E501 + settings ([ConnectorSetting]): [optional] # noqa: E501 + service_id (str): Service provider identifier. [optional] # noqa: E501 + unified_apis ([ConnectorUnifiedApis]): List of Unified APIs that feature this connector.. [optional] # noqa: E501 + supported_resources ([LinkedConnectorResource]): List of resources that are supported on the connector.. [optional] # noqa: E501 + configurable_resources ([str]): List of resources that have settings that can be configured.. [optional] # noqa: E501 + supported_events ([ConnectorEvent]): List of events that are supported on the connector across all Unified APIs.. [optional] # noqa: E501 + webhook_support ([WebhookSupport]): How webhooks are supported for the connector. Sometimes the connector natively supports webhooks, other times Apideck virtualizes them based on polling.. [optional] # noqa: E501 + docs ([ConnectorDoc]): [optional] # noqa: E501 + tls_support (ConnectorTlsSupport): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/connector_doc.py b/src/apideck/model/connector_doc.py new file mode 100644 index 0000000000..268fe04321 --- /dev/null +++ b/src/apideck/model/connector_doc.py @@ -0,0 +1,279 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class ConnectorDoc(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('audience',): { + 'APPLICATION_OWNER': "application_owner", + 'CONSUMER': "consumer", + }, + ('format',): { + 'MARKDOWN': "markdown", + }, + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'id': (str,), # noqa: E501 + 'name': (str,), # noqa: E501 + 'audience': (str,), # noqa: E501 + 'format': (str,), # noqa: E501 + 'url': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'name': 'name', # noqa: E501 + 'audience': 'audience', # noqa: E501 + 'format': 'format', # noqa: E501 + 'url': 'url', # noqa: E501 + } + + read_only_vars = { + 'id', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ConnectorDoc - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + name (str): Name of the doc.. [optional] # noqa: E501 + audience (str): Audience for the doc.. [optional] # noqa: E501 + format (str): Format of the doc.. [optional] if omitted the server will use the default value of "markdown" # noqa: E501 + url (str): Link to fetch the content of the doc.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """ConnectorDoc - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + name (str): Name of the doc.. [optional] # noqa: E501 + audience (str): Audience for the doc.. [optional] # noqa: E501 + format (str): Format of the doc.. [optional] if omitted the server will use the default value of "markdown" # noqa: E501 + url (str): Link to fetch the content of the doc.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/connector_event.py b/src/apideck/model/connector_event.py new file mode 100644 index 0000000000..e28d230f69 --- /dev/null +++ b/src/apideck/model/connector_event.py @@ -0,0 +1,271 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class ConnectorEvent(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('event_source',): { + 'NATIVE': "native", + 'VIRTUAL': "virtual", + }, + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'event_type': (str,), # noqa: E501 + 'event_source': (str,), # noqa: E501 + 'downstream_event_type': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'event_type': 'event_type', # noqa: E501 + 'event_source': 'event_source', # noqa: E501 + 'downstream_event_type': 'downstream_event_type', # noqa: E501 + 'resource': 'resource', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ConnectorEvent - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + event_type (str): Unify event type. [optional] # noqa: E501 + event_source (str): Unify event source. [optional] # noqa: E501 + downstream_event_type (str): Downstream event type. [optional] # noqa: E501 + resource (str): ID of the resource, typically a lowercased version of name.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """ConnectorEvent - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + event_type (str): Unify event type. [optional] # noqa: E501 + event_source (str): Unify event source. [optional] # noqa: E501 + downstream_event_type (str): Downstream event type. [optional] # noqa: E501 + resource (str): ID of the resource, typically a lowercased version of name.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/connector_oauth_scopes.py b/src/apideck/model/connector_oauth_scopes.py new file mode 100644 index 0000000000..d2f61208ee --- /dev/null +++ b/src/apideck/model/connector_oauth_scopes.py @@ -0,0 +1,263 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class ConnectorOauthScopes(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'id': (str,), # noqa: E501 + 'label': (str,), # noqa: E501 + 'default_apis': ([str],), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'label': 'label', # noqa: E501 + 'default_apis': 'default_apis', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ConnectorOauthScopes - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): ID of the OAuth scope.. [optional] # noqa: E501 + label (str): Label of the OAuth scope.. [optional] # noqa: E501 + default_apis ([str]): List of Unified APIs that request this OAuth Scope by default. Application owners can customize the requested scopes.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """ConnectorOauthScopes - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): ID of the OAuth scope.. [optional] # noqa: E501 + label (str): Label of the OAuth scope.. [optional] # noqa: E501 + default_apis ([str]): List of Unified APIs that request this OAuth Scope by default. Application owners can customize the requested scopes.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/connector_oauth_scopes1.py b/src/apideck/model/connector_oauth_scopes1.py new file mode 100644 index 0000000000..cb0d1aae7a --- /dev/null +++ b/src/apideck/model/connector_oauth_scopes1.py @@ -0,0 +1,259 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class ConnectorOauthScopes1(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'id': (str,), # noqa: E501 + 'label': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'label': 'label', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ConnectorOauthScopes1 - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): ID of the OAuth scope.. [optional] # noqa: E501 + label (str): Label of the OAuth scope.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """ConnectorOauthScopes1 - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): ID of the OAuth scope.. [optional] # noqa: E501 + label (str): Label of the OAuth scope.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/connector_resource.py b/src/apideck/model/connector_resource.py new file mode 100644 index 0000000000..64e357fcb0 --- /dev/null +++ b/src/apideck/model/connector_resource.py @@ -0,0 +1,317 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.pagination_coverage import PaginationCoverage + from apideck.model.resource_status import ResourceStatus + from apideck.model.supported_property import SupportedProperty + globals()['PaginationCoverage'] = PaginationCoverage + globals()['ResourceStatus'] = ResourceStatus + globals()['SupportedProperty'] = SupportedProperty + + +class ConnectorResource(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'id': (str,), # noqa: E501 + 'name': (str,), # noqa: E501 + 'downstream_id': (str,), # noqa: E501 + 'downstream_name': (str,), # noqa: E501 + 'status': (ResourceStatus,), # noqa: E501 + 'pagination_supported': (bool,), # noqa: E501 + 'pagination': (PaginationCoverage,), # noqa: E501 + 'custom_fields_supported': (bool,), # noqa: E501 + 'supported_operations': ([str],), # noqa: E501 + 'downstream_unsupported_operations': ([str],), # noqa: E501 + 'supported_filters': ([str],), # noqa: E501 + 'supported_sort_by': ([str],), # noqa: E501 + 'supported_fields': ([SupportedProperty],), # noqa: E501 + 'supported_list_fields': ([SupportedProperty],), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'name': 'name', # noqa: E501 + 'downstream_id': 'downstream_id', # noqa: E501 + 'downstream_name': 'downstream_name', # noqa: E501 + 'status': 'status', # noqa: E501 + 'pagination_supported': 'pagination_supported', # noqa: E501 + 'pagination': 'pagination', # noqa: E501 + 'custom_fields_supported': 'custom_fields_supported', # noqa: E501 + 'supported_operations': 'supported_operations', # noqa: E501 + 'downstream_unsupported_operations': 'downstream_unsupported_operations', # noqa: E501 + 'supported_filters': 'supported_filters', # noqa: E501 + 'supported_sort_by': 'supported_sort_by', # noqa: E501 + 'supported_fields': 'supported_fields', # noqa: E501 + 'supported_list_fields': 'supported_list_fields', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ConnectorResource - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): ID of the resource, typically a lowercased version of name.. [optional] # noqa: E501 + name (str): Name of the resource (plural). [optional] # noqa: E501 + downstream_id (str): ID of the resource in the Connector's API (downstream). [optional] # noqa: E501 + downstream_name (str): Name of the resource in the Connector's API (downstream). [optional] # noqa: E501 + status (ResourceStatus): [optional] # noqa: E501 + pagination_supported (bool): Indicates if pagination (cursor and limit parameters) is supported on the list endpoint of the resource.. [optional] # noqa: E501 + pagination (PaginationCoverage): [optional] # noqa: E501 + custom_fields_supported (bool): Indicates if custom fields are supported on this resource.. [optional] # noqa: E501 + supported_operations ([str]): List of supported operations on the resource.. [optional] # noqa: E501 + downstream_unsupported_operations ([str]): List of operations that are not supported on the downstream.. [optional] # noqa: E501 + supported_filters ([str]): Supported filters on the list endpoint of the resource.. [optional] # noqa: E501 + supported_sort_by ([str]): Supported sorting properties on the list endpoint of the resource.. [optional] # noqa: E501 + supported_fields ([SupportedProperty]): Supported fields on the detail endpoint.. [optional] # noqa: E501 + supported_list_fields ([SupportedProperty]): Supported fields on the list endpoint.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """ConnectorResource - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): ID of the resource, typically a lowercased version of name.. [optional] # noqa: E501 + name (str): Name of the resource (plural). [optional] # noqa: E501 + downstream_id (str): ID of the resource in the Connector's API (downstream). [optional] # noqa: E501 + downstream_name (str): Name of the resource in the Connector's API (downstream). [optional] # noqa: E501 + status (ResourceStatus): [optional] # noqa: E501 + pagination_supported (bool): Indicates if pagination (cursor and limit parameters) is supported on the list endpoint of the resource.. [optional] # noqa: E501 + pagination (PaginationCoverage): [optional] # noqa: E501 + custom_fields_supported (bool): Indicates if custom fields are supported on this resource.. [optional] # noqa: E501 + supported_operations ([str]): List of supported operations on the resource.. [optional] # noqa: E501 + downstream_unsupported_operations ([str]): List of operations that are not supported on the downstream.. [optional] # noqa: E501 + supported_filters ([str]): Supported filters on the list endpoint of the resource.. [optional] # noqa: E501 + supported_sort_by ([str]): Supported sorting properties on the list endpoint of the resource.. [optional] # noqa: E501 + supported_fields ([SupportedProperty]): Supported fields on the detail endpoint.. [optional] # noqa: E501 + supported_list_fields ([SupportedProperty]): Supported fields on the list endpoint.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/connector_setting.py b/src/apideck/model/connector_setting.py new file mode 100644 index 0000000000..5ee06576ab --- /dev/null +++ b/src/apideck/model/connector_setting.py @@ -0,0 +1,279 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class ConnectorSetting(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('type',): { + 'TEXT': "text", + 'CHECKBOX': "checkbox", + 'TEL': "tel", + 'EMAIL': "email", + 'URL': "url", + 'TEXTAREA': "textarea", + 'SELECT': "select", + 'FILTERED-SELECT': "filtered-select", + 'MULTI-SELECT': "multi-select", + 'DATETIME': "datetime", + 'DATE': "date", + 'TIME': "time", + 'NUMBER': "number", + 'PASSWORD': "password", + }, + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'id': (str,), # noqa: E501 + 'label': (str,), # noqa: E501 + 'type': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'label': 'label', # noqa: E501 + 'type': 'type', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ConnectorSetting - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + label (str): [optional] # noqa: E501 + type (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """ConnectorSetting - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + label (str): [optional] # noqa: E501 + type (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/connector_status.py b/src/apideck/model/connector_status.py new file mode 100644 index 0000000000..2f6bd289d8 --- /dev/null +++ b/src/apideck/model/connector_status.py @@ -0,0 +1,284 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class ConnectorStatus(ModelSimple): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('value',): { + 'LIVE': "live", + 'BETA': "beta", + 'DEVELOPMENT': "development", + 'CONSIDERING': "considering", + }, + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'value': (str,), + } + + @cached_property + def discriminator(): + return None + + + attribute_map = {} + + read_only_vars = set() + + _composed_schemas = None + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): + """ConnectorStatus - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] (str): Status of the connector. Connectors with status live or beta are callable.., must be one of ["live", "beta", "development", "considering", ] # noqa: E501 + + Keyword Args: + value (str): Status of the connector. Connectors with status live or beta are callable.., must be one of ["live", "beta", "development", "considering", ] # noqa: E501 + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + self.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): + """ConnectorStatus - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] (str): Status of the connector. Connectors with status live or beta are callable.., must be one of ["live", "beta", "development", "considering", ] # noqa: E501 + + Keyword Args: + value (str): Status of the connector. Connectors with status live or beta are callable.., must be one of ["live", "beta", "development", "considering", ] # noqa: E501 + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + self.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + return self diff --git a/src/apideck/model/connector_tls_support.py b/src/apideck/model/connector_tls_support.py new file mode 100644 index 0000000000..3394239754 --- /dev/null +++ b/src/apideck/model/connector_tls_support.py @@ -0,0 +1,259 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class ConnectorTlsSupport(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'type': (str,), # noqa: E501 + 'description': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'type': 'type', # noqa: E501 + 'description': 'description', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ConnectorTlsSupport - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + type (str): [optional] # noqa: E501 + description (str): Description of the TLS support. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """ConnectorTlsSupport - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + type (str): [optional] # noqa: E501 + description (str): Description of the TLS support. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/connector_unified_apis.py b/src/apideck/model/connector_unified_apis.py new file mode 100644 index 0000000000..e5eeedaf14 --- /dev/null +++ b/src/apideck/model/connector_unified_apis.py @@ -0,0 +1,287 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.connector_event import ConnectorEvent + from apideck.model.connector_oauth_scopes1 import ConnectorOauthScopes1 + from apideck.model.linked_connector_resource import LinkedConnectorResource + from apideck.model.unified_api_id import UnifiedApiId + globals()['ConnectorEvent'] = ConnectorEvent + globals()['ConnectorOauthScopes1'] = ConnectorOauthScopes1 + globals()['LinkedConnectorResource'] = LinkedConnectorResource + globals()['UnifiedApiId'] = UnifiedApiId + + +class ConnectorUnifiedApis(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'id': (UnifiedApiId,), # noqa: E501 + 'name': (str,), # noqa: E501 + 'oauth_scopes': ([ConnectorOauthScopes1],), # noqa: E501 + 'supported_resources': ([LinkedConnectorResource],), # noqa: E501 + 'downstream_unsupported_resources': ([str],), # noqa: E501 + 'supported_events': ([ConnectorEvent],), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'name': 'name', # noqa: E501 + 'oauth_scopes': 'oauth_scopes', # noqa: E501 + 'supported_resources': 'supported_resources', # noqa: E501 + 'downstream_unsupported_resources': 'downstream_unsupported_resources', # noqa: E501 + 'supported_events': 'supported_events', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ConnectorUnifiedApis - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (UnifiedApiId): [optional] # noqa: E501 + name (str): Name of the API.. [optional] # noqa: E501 + oauth_scopes ([ConnectorOauthScopes1]): [optional] # noqa: E501 + supported_resources ([LinkedConnectorResource]): List of resources that are supported on the connector.. [optional] # noqa: E501 + downstream_unsupported_resources ([str]): List of resources that are not supported on the downstream.. [optional] # noqa: E501 + supported_events ([ConnectorEvent]): List of events that are supported on the connector for this Unified API.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """ConnectorUnifiedApis - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (UnifiedApiId): [optional] # noqa: E501 + name (str): Name of the API.. [optional] # noqa: E501 + oauth_scopes ([ConnectorOauthScopes1]): [optional] # noqa: E501 + supported_resources ([LinkedConnectorResource]): List of resources that are supported on the connector.. [optional] # noqa: E501 + downstream_unsupported_resources ([str]): List of resources that are not supported on the downstream.. [optional] # noqa: E501 + supported_events ([ConnectorEvent]): List of events that are supported on the connector for this Unified API.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/connectors_filter.py b/src/apideck/model/connectors_filter.py new file mode 100644 index 0000000000..099dc6c891 --- /dev/null +++ b/src/apideck/model/connectors_filter.py @@ -0,0 +1,260 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.connector_status import ConnectorStatus + from apideck.model.unified_api_id import UnifiedApiId + globals()['ConnectorStatus'] = ConnectorStatus + globals()['UnifiedApiId'] = UnifiedApiId + + +class ConnectorsFilter(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'unified_api': (UnifiedApiId,), # noqa: E501 + 'status': (ConnectorStatus,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'unified_api': 'unified_api', # noqa: E501 + 'status': 'status', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ConnectorsFilter - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + unified_api (UnifiedApiId): [optional] # noqa: E501 + status (ConnectorStatus): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """ConnectorsFilter - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + unified_api (UnifiedApiId): [optional] # noqa: E501 + status (ConnectorStatus): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/consumer.py b/src/apideck/model/consumer.py new file mode 100644 index 0000000000..fe7b01971d --- /dev/null +++ b/src/apideck/model/consumer.py @@ -0,0 +1,301 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.consumer_connection import ConsumerConnection + from apideck.model.consumer_metadata import ConsumerMetadata + from apideck.model.request_count_allocation import RequestCountAllocation + globals()['ConsumerConnection'] = ConsumerConnection + globals()['ConsumerMetadata'] = ConsumerMetadata + globals()['RequestCountAllocation'] = RequestCountAllocation + + +class Consumer(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'consumer_id': (str,), # noqa: E501 + 'application_id': (str,), # noqa: E501 + 'metadata': (ConsumerMetadata,), # noqa: E501 + 'connections': ([ConsumerConnection],), # noqa: E501 + 'services': ([str],), # noqa: E501 + 'aggregated_request_count': (float,), # noqa: E501 + 'request_counts': (RequestCountAllocation,), # noqa: E501 + 'created': (str,), # noqa: E501 + 'modified': (str,), # noqa: E501 + 'request_count_updated': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'consumer_id': 'consumer_id', # noqa: E501 + 'application_id': 'application_id', # noqa: E501 + 'metadata': 'metadata', # noqa: E501 + 'connections': 'connections', # noqa: E501 + 'services': 'services', # noqa: E501 + 'aggregated_request_count': 'aggregated_request_count', # noqa: E501 + 'request_counts': 'request_counts', # noqa: E501 + 'created': 'created', # noqa: E501 + 'modified': 'modified', # noqa: E501 + 'request_count_updated': 'request_count_updated', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """Consumer - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + consumer_id (str): [optional] # noqa: E501 + application_id (str): [optional] # noqa: E501 + metadata (ConsumerMetadata): [optional] # noqa: E501 + connections ([ConsumerConnection]): [optional] # noqa: E501 + services ([str]): [optional] # noqa: E501 + aggregated_request_count (float): [optional] # noqa: E501 + request_counts (RequestCountAllocation): [optional] # noqa: E501 + created (str): [optional] # noqa: E501 + modified (str): [optional] # noqa: E501 + request_count_updated (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """Consumer - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + consumer_id (str): [optional] # noqa: E501 + application_id (str): [optional] # noqa: E501 + metadata (ConsumerMetadata): [optional] # noqa: E501 + connections ([ConsumerConnection]): [optional] # noqa: E501 + services ([str]): [optional] # noqa: E501 + aggregated_request_count (float): [optional] # noqa: E501 + request_counts (RequestCountAllocation): [optional] # noqa: E501 + created (str): [optional] # noqa: E501 + modified (str): [optional] # noqa: E501 + request_count_updated (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/consumer_connection.py b/src/apideck/model/consumer_connection.py new file mode 100644 index 0000000000..de2d4b500e --- /dev/null +++ b/src/apideck/model/consumer_connection.py @@ -0,0 +1,331 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.auth_type import AuthType + globals()['AuthType'] = AuthType + + +class ConsumerConnection(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('state',): { + 'AVAILABLE': "available", + 'CALLABLE': "callable", + 'ADDED': "added", + 'CONFIGURED': "configured", + 'AUTHORIZED': "authorized", + }, + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'id': (str,), # noqa: E501 + 'name': (str,), # noqa: E501 + 'icon': (str,), # noqa: E501 + 'logo': (str,), # noqa: E501 + 'website': (str,), # noqa: E501 + 'tag_line': (str,), # noqa: E501 + 'service_id': (str,), # noqa: E501 + 'unified_api': (str,), # noqa: E501 + 'consumer_id': (str,), # noqa: E501 + 'auth_type': (AuthType,), # noqa: E501 + 'enabled': (bool,), # noqa: E501 + 'settings': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type,), # noqa: E501 + 'metadata': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type,), # noqa: E501 + 'created_at': (str,), # noqa: E501 + 'updated_at': (str, none_type,), # noqa: E501 + 'state': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'name': 'name', # noqa: E501 + 'icon': 'icon', # noqa: E501 + 'logo': 'logo', # noqa: E501 + 'website': 'website', # noqa: E501 + 'tag_line': 'tag_line', # noqa: E501 + 'service_id': 'service_id', # noqa: E501 + 'unified_api': 'unified_api', # noqa: E501 + 'consumer_id': 'consumer_id', # noqa: E501 + 'auth_type': 'auth_type', # noqa: E501 + 'enabled': 'enabled', # noqa: E501 + 'settings': 'settings', # noqa: E501 + 'metadata': 'metadata', # noqa: E501 + 'created_at': 'created_at', # noqa: E501 + 'updated_at': 'updated_at', # noqa: E501 + 'state': 'state', # noqa: E501 + } + + read_only_vars = { + 'id', # noqa: E501 + 'website', # noqa: E501 + 'tag_line', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ConsumerConnection - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + name (str): [optional] # noqa: E501 + icon (str): [optional] # noqa: E501 + logo (str): [optional] # noqa: E501 + website (str): [optional] # noqa: E501 + tag_line (str): [optional] # noqa: E501 + service_id (str): [optional] # noqa: E501 + unified_api (str): [optional] # noqa: E501 + consumer_id (str): [optional] # noqa: E501 + auth_type (AuthType): [optional] # noqa: E501 + enabled (bool): [optional] # noqa: E501 + settings ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Connection settings. Values will persist to `form_fields` with corresponding id. [optional] # noqa: E501 + metadata ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Attach your own consumer specific metadata. [optional] # noqa: E501 + created_at (str): [optional] # noqa: E501 + updated_at (str, none_type): [optional] # noqa: E501 + state (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """ConsumerConnection - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + name (str): [optional] # noqa: E501 + icon (str): [optional] # noqa: E501 + logo (str): [optional] # noqa: E501 + website (str): [optional] # noqa: E501 + tag_line (str): [optional] # noqa: E501 + service_id (str): [optional] # noqa: E501 + unified_api (str): [optional] # noqa: E501 + consumer_id (str): [optional] # noqa: E501 + auth_type (AuthType): [optional] # noqa: E501 + enabled (bool): [optional] # noqa: E501 + settings ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Connection settings. Values will persist to `form_fields` with corresponding id. [optional] # noqa: E501 + metadata ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Attach your own consumer specific metadata. [optional] # noqa: E501 + created_at (str): [optional] # noqa: E501 + updated_at (str, none_type): [optional] # noqa: E501 + state (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/consumer_metadata.py b/src/apideck/model/consumer_metadata.py new file mode 100644 index 0000000000..b265e6845a --- /dev/null +++ b/src/apideck/model/consumer_metadata.py @@ -0,0 +1,267 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class ConsumerMetadata(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'account_name': (str,), # noqa: E501 + 'user_name': (str,), # noqa: E501 + 'email': (str,), # noqa: E501 + 'image': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'account_name': 'account_name', # noqa: E501 + 'user_name': 'user_name', # noqa: E501 + 'email': 'email', # noqa: E501 + 'image': 'image', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ConsumerMetadata - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + account_name (str): [optional] # noqa: E501 + user_name (str): [optional] # noqa: E501 + email (str): [optional] # noqa: E501 + image (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """ConsumerMetadata - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + account_name (str): [optional] # noqa: E501 + user_name (str): [optional] # noqa: E501 + email (str): [optional] # noqa: E501 + image (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/consumer_request_counts_in_date_range_response.py b/src/apideck/model/consumer_request_counts_in_date_range_response.py new file mode 100644 index 0000000000..f7fd0372e8 --- /dev/null +++ b/src/apideck/model/consumer_request_counts_in_date_range_response.py @@ -0,0 +1,279 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.consumer_request_counts_in_date_range_response_data import ConsumerRequestCountsInDateRangeResponseData + globals()['ConsumerRequestCountsInDateRangeResponseData'] = ConsumerRequestCountsInDateRangeResponseData + + +class ConsumerRequestCountsInDateRangeResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'data': (ConsumerRequestCountsInDateRangeResponseData,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, data, *args, **kwargs): # noqa: E501 + """ConsumerRequestCountsInDateRangeResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + data (ConsumerRequestCountsInDateRangeResponseData): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, data, *args, **kwargs): # noqa: E501 + """ConsumerRequestCountsInDateRangeResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + data (ConsumerRequestCountsInDateRangeResponseData): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/consumer_request_counts_in_date_range_response_data.py b/src/apideck/model/consumer_request_counts_in_date_range_response_data.py new file mode 100644 index 0000000000..6c73a4ae16 --- /dev/null +++ b/src/apideck/model/consumer_request_counts_in_date_range_response_data.py @@ -0,0 +1,281 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.request_count_allocation import RequestCountAllocation + globals()['RequestCountAllocation'] = RequestCountAllocation + + +class ConsumerRequestCountsInDateRangeResponseData(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'application_id': (str,), # noqa: E501 + 'consumer_id': (str,), # noqa: E501 + 'start_datetime': (str,), # noqa: E501 + 'end_datetime': (str,), # noqa: E501 + 'aggregated_request_count': (float,), # noqa: E501 + 'request_counts': (RequestCountAllocation,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'application_id': 'application_id', # noqa: E501 + 'consumer_id': 'consumer_id', # noqa: E501 + 'start_datetime': 'start_datetime', # noqa: E501 + 'end_datetime': 'end_datetime', # noqa: E501 + 'aggregated_request_count': 'aggregated_request_count', # noqa: E501 + 'request_counts': 'request_counts', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ConsumerRequestCountsInDateRangeResponseData - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + application_id (str): [optional] # noqa: E501 + consumer_id (str): [optional] # noqa: E501 + start_datetime (str): [optional] # noqa: E501 + end_datetime (str): [optional] # noqa: E501 + aggregated_request_count (float): [optional] # noqa: E501 + request_counts (RequestCountAllocation): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """ConsumerRequestCountsInDateRangeResponseData - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + application_id (str): [optional] # noqa: E501 + consumer_id (str): [optional] # noqa: E501 + start_datetime (str): [optional] # noqa: E501 + end_datetime (str): [optional] # noqa: E501 + aggregated_request_count (float): [optional] # noqa: E501 + request_counts (RequestCountAllocation): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/contact.py b/src/apideck/model/contact.py new file mode 100644 index 0000000000..1f8c256e37 --- /dev/null +++ b/src/apideck/model/contact.py @@ -0,0 +1,442 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.address import Address + from apideck.model.custom_field import CustomField + from apideck.model.email import Email + from apideck.model.phone_number import PhoneNumber + from apideck.model.social_link import SocialLink + from apideck.model.tags import Tags + from apideck.model.website import Website + globals()['Address'] = Address + globals()['CustomField'] = CustomField + globals()['Email'] = Email + globals()['PhoneNumber'] = PhoneNumber + globals()['SocialLink'] = SocialLink + globals()['Tags'] = Tags + globals()['Website'] = Website + + +class Contact(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('type',): { + 'None': None, + 'CUSTOMER': "customer", + 'SUPPLIER': "supplier", + 'EMPLOYEE': "employee", + 'PERSONAL': "personal", + }, + ('gender',): { + 'None': None, + 'MALE': "male", + 'FEMALE': "female", + 'UNISEX': "unisex", + }, + } + + validations = { + ('name',): { + 'min_length': 1, + }, + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'name': (str,), # noqa: E501 + 'id': (str,), # noqa: E501 + 'owner_id': (str, none_type,), # noqa: E501 + 'type': (str, none_type,), # noqa: E501 + 'company_id': (str, none_type,), # noqa: E501 + 'company_name': (str, none_type,), # noqa: E501 + 'lead_id': (str, none_type,), # noqa: E501 + 'first_name': (str, none_type,), # noqa: E501 + 'middle_name': (str, none_type,), # noqa: E501 + 'last_name': (str, none_type,), # noqa: E501 + 'prefix': (str, none_type,), # noqa: E501 + 'suffix': (str, none_type,), # noqa: E501 + 'title': (str, none_type,), # noqa: E501 + 'department': (str, none_type,), # noqa: E501 + 'language': (str, none_type,), # noqa: E501 + 'gender': (str, none_type,), # noqa: E501 + 'birthday': (str, none_type,), # noqa: E501 + 'image': (str, none_type,), # noqa: E501 + 'photo_url': (str, none_type,), # noqa: E501 + 'lead_source': (str, none_type,), # noqa: E501 + 'fax': (str, none_type,), # noqa: E501 + 'description': (str, none_type,), # noqa: E501 + 'current_balance': (float, none_type,), # noqa: E501 + 'status': (str, none_type,), # noqa: E501 + 'active': (bool, none_type,), # noqa: E501 + 'websites': ([Website],), # noqa: E501 + 'addresses': ([Address],), # noqa: E501 + 'social_links': ([SocialLink],), # noqa: E501 + 'phone_numbers': ([PhoneNumber],), # noqa: E501 + 'emails': ([Email],), # noqa: E501 + 'email_domain': (str, none_type,), # noqa: E501 + 'custom_fields': ([CustomField],), # noqa: E501 + 'tags': (Tags,), # noqa: E501 + 'first_call_at': (datetime, none_type,), # noqa: E501 + 'first_email_at': (datetime, none_type,), # noqa: E501 + 'last_activity_at': (datetime, none_type,), # noqa: E501 + 'updated_at': (datetime,), # noqa: E501 + 'created_at': (datetime,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'name': 'name', # noqa: E501 + 'id': 'id', # noqa: E501 + 'owner_id': 'owner_id', # noqa: E501 + 'type': 'type', # noqa: E501 + 'company_id': 'company_id', # noqa: E501 + 'company_name': 'company_name', # noqa: E501 + 'lead_id': 'lead_id', # noqa: E501 + 'first_name': 'first_name', # noqa: E501 + 'middle_name': 'middle_name', # noqa: E501 + 'last_name': 'last_name', # noqa: E501 + 'prefix': 'prefix', # noqa: E501 + 'suffix': 'suffix', # noqa: E501 + 'title': 'title', # noqa: E501 + 'department': 'department', # noqa: E501 + 'language': 'language', # noqa: E501 + 'gender': 'gender', # noqa: E501 + 'birthday': 'birthday', # noqa: E501 + 'image': 'image', # noqa: E501 + 'photo_url': 'photo_url', # noqa: E501 + 'lead_source': 'lead_source', # noqa: E501 + 'fax': 'fax', # noqa: E501 + 'description': 'description', # noqa: E501 + 'current_balance': 'current_balance', # noqa: E501 + 'status': 'status', # noqa: E501 + 'active': 'active', # noqa: E501 + 'websites': 'websites', # noqa: E501 + 'addresses': 'addresses', # noqa: E501 + 'social_links': 'social_links', # noqa: E501 + 'phone_numbers': 'phone_numbers', # noqa: E501 + 'emails': 'emails', # noqa: E501 + 'email_domain': 'email_domain', # noqa: E501 + 'custom_fields': 'custom_fields', # noqa: E501 + 'tags': 'tags', # noqa: E501 + 'first_call_at': 'first_call_at', # noqa: E501 + 'first_email_at': 'first_email_at', # noqa: E501 + 'last_activity_at': 'last_activity_at', # noqa: E501 + 'updated_at': 'updated_at', # noqa: E501 + 'created_at': 'created_at', # noqa: E501 + } + + read_only_vars = { + 'id', # noqa: E501 + 'first_call_at', # noqa: E501 + 'first_email_at', # noqa: E501 + 'last_activity_at', # noqa: E501 + 'updated_at', # noqa: E501 + 'created_at', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, name, *args, **kwargs): # noqa: E501 + """Contact - a model defined in OpenAPI + + Args: + name (str): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + owner_id (str, none_type): [optional] # noqa: E501 + type (str, none_type): [optional] # noqa: E501 + company_id (str, none_type): [optional] # noqa: E501 + company_name (str, none_type): [optional] # noqa: E501 + lead_id (str, none_type): [optional] # noqa: E501 + first_name (str, none_type): [optional] # noqa: E501 + middle_name (str, none_type): [optional] # noqa: E501 + last_name (str, none_type): [optional] # noqa: E501 + prefix (str, none_type): [optional] # noqa: E501 + suffix (str, none_type): [optional] # noqa: E501 + title (str, none_type): [optional] # noqa: E501 + department (str, none_type): [optional] # noqa: E501 + language (str, none_type): language code according to ISO 639-1. For the United States - EN. [optional] # noqa: E501 + gender (str, none_type): [optional] # noqa: E501 + birthday (str, none_type): [optional] # noqa: E501 + image (str, none_type): [optional] # noqa: E501 + photo_url (str, none_type): [optional] # noqa: E501 + lead_source (str, none_type): [optional] # noqa: E501 + fax (str, none_type): [optional] # noqa: E501 + description (str, none_type): [optional] # noqa: E501 + current_balance (float, none_type): [optional] # noqa: E501 + status (str, none_type): [optional] # noqa: E501 + active (bool, none_type): [optional] # noqa: E501 + websites ([Website]): [optional] # noqa: E501 + addresses ([Address]): [optional] # noqa: E501 + social_links ([SocialLink]): [optional] # noqa: E501 + phone_numbers ([PhoneNumber]): [optional] # noqa: E501 + emails ([Email]): [optional] # noqa: E501 + email_domain (str, none_type): [optional] # noqa: E501 + custom_fields ([CustomField]): [optional] # noqa: E501 + tags (Tags): [optional] # noqa: E501 + first_call_at (datetime, none_type): [optional] # noqa: E501 + first_email_at (datetime, none_type): [optional] # noqa: E501 + last_activity_at (datetime, none_type): [optional] # noqa: E501 + updated_at (datetime): [optional] # noqa: E501 + created_at (datetime): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.name = name + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, name, *args, **kwargs): # noqa: E501 + """Contact - a model defined in OpenAPI + + Args: + name (str): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + owner_id (str, none_type): [optional] # noqa: E501 + type (str, none_type): [optional] # noqa: E501 + company_id (str, none_type): [optional] # noqa: E501 + company_name (str, none_type): [optional] # noqa: E501 + lead_id (str, none_type): [optional] # noqa: E501 + first_name (str, none_type): [optional] # noqa: E501 + middle_name (str, none_type): [optional] # noqa: E501 + last_name (str, none_type): [optional] # noqa: E501 + prefix (str, none_type): [optional] # noqa: E501 + suffix (str, none_type): [optional] # noqa: E501 + title (str, none_type): [optional] # noqa: E501 + department (str, none_type): [optional] # noqa: E501 + language (str, none_type): language code according to ISO 639-1. For the United States - EN. [optional] # noqa: E501 + gender (str, none_type): [optional] # noqa: E501 + birthday (str, none_type): [optional] # noqa: E501 + image (str, none_type): [optional] # noqa: E501 + photo_url (str, none_type): [optional] # noqa: E501 + lead_source (str, none_type): [optional] # noqa: E501 + fax (str, none_type): [optional] # noqa: E501 + description (str, none_type): [optional] # noqa: E501 + current_balance (float, none_type): [optional] # noqa: E501 + status (str, none_type): [optional] # noqa: E501 + active (bool, none_type): [optional] # noqa: E501 + websites ([Website]): [optional] # noqa: E501 + addresses ([Address]): [optional] # noqa: E501 + social_links ([SocialLink]): [optional] # noqa: E501 + phone_numbers ([PhoneNumber]): [optional] # noqa: E501 + emails ([Email]): [optional] # noqa: E501 + email_domain (str, none_type): [optional] # noqa: E501 + custom_fields ([CustomField]): [optional] # noqa: E501 + tags (Tags): [optional] # noqa: E501 + first_call_at (datetime, none_type): [optional] # noqa: E501 + first_email_at (datetime, none_type): [optional] # noqa: E501 + last_activity_at (datetime, none_type): [optional] # noqa: E501 + updated_at (datetime): [optional] # noqa: E501 + created_at (datetime): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.name = name + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/contacts_filter.py b/src/apideck/model/contacts_filter.py new file mode 100644 index 0000000000..74abddd4bd --- /dev/null +++ b/src/apideck/model/contacts_filter.py @@ -0,0 +1,261 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class ContactsFilter(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'name': (str,), # noqa: E501 + 'first_name': (str,), # noqa: E501 + 'last_name': (str,), # noqa: E501 + 'email': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'name': 'name', # noqa: E501 + 'first_name': 'first_name', # noqa: E501 + 'last_name': 'last_name', # noqa: E501 + 'email': 'email', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ContactsFilter - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + name (str): Name of the contact to filter on. [optional] # noqa: E501 + first_name (str): First name of the contact to filter on. [optional] # noqa: E501 + last_name (str): Last name of the contact to filter on. [optional] # noqa: E501 + email (str): E-mail of the contact to filter on. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """ContactsFilter - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + name (str): Name of the contact to filter on. [optional] # noqa: E501 + first_name (str): First name of the contact to filter on. [optional] # noqa: E501 + last_name (str): Last name of the contact to filter on. [optional] # noqa: E501 + email (str): E-mail of the contact to filter on. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/contacts_sort.py b/src/apideck/model/contacts_sort.py new file mode 100644 index 0000000000..dce8790db2 --- /dev/null +++ b/src/apideck/model/contacts_sort.py @@ -0,0 +1,266 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.sort_direction import SortDirection + globals()['SortDirection'] = SortDirection + + +class ContactsSort(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('by',): { + 'CREATED_AT': "created_at", + 'UPDATED_AT': "updated_at", + 'NAME': "name", + 'FIRST_NAME': "first_name", + 'LAST_NAME': "last_name", + 'EMAIL': "email", + }, + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'by': (str,), # noqa: E501 + 'direction': (SortDirection,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'by': 'by', # noqa: E501 + 'direction': 'direction', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ContactsSort - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + by (str): The field on which to sort the Contacts. [optional] # noqa: E501 + direction (SortDirection): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """ContactsSort - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + by (str): The field on which to sort the Contacts. [optional] # noqa: E501 + direction (SortDirection): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/copy_folder_request.py b/src/apideck/model/copy_folder_request.py new file mode 100644 index 0000000000..4704137ed6 --- /dev/null +++ b/src/apideck/model/copy_folder_request.py @@ -0,0 +1,264 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class CopyFolderRequest(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'parent_folder_id': (str,), # noqa: E501 + 'id': (str,), # noqa: E501 + 'name': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'parent_folder_id': 'parent_folder_id', # noqa: E501 + 'id': 'id', # noqa: E501 + 'name': 'name', # noqa: E501 + } + + read_only_vars = { + 'id', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, parent_folder_id, *args, **kwargs): # noqa: E501 + """CopyFolderRequest - a model defined in OpenAPI + + Args: + parent_folder_id (str): The parent folder to create the new file within. + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + name (str): The name of the folder.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.parent_folder_id = parent_folder_id + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, parent_folder_id, *args, **kwargs): # noqa: E501 + """CopyFolderRequest - a model defined in OpenAPI + + Args: + parent_folder_id (str): The parent folder to create the new file within. + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + name (str): The name of the folder.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.parent_folder_id = parent_folder_id + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/create_activity_response.py b/src/apideck/model/create_activity_response.py new file mode 100644 index 0000000000..750114dbaa --- /dev/null +++ b/src/apideck/model/create_activity_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_id import UnifiedId + globals()['UnifiedId'] = UnifiedId + + +class CreateActivityResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """CreateActivityResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """CreateActivityResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/create_applicant_response.py b/src/apideck/model/create_applicant_response.py new file mode 100644 index 0000000000..893287f64c --- /dev/null +++ b/src/apideck/model/create_applicant_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_id import UnifiedId + globals()['UnifiedId'] = UnifiedId + + +class CreateApplicantResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """CreateApplicantResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """CreateApplicantResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/create_bill_response.py b/src/apideck/model/create_bill_response.py new file mode 100644 index 0000000000..c40c24e40c --- /dev/null +++ b/src/apideck/model/create_bill_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_id import UnifiedId + globals()['UnifiedId'] = UnifiedId + + +class CreateBillResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """CreateBillResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """CreateBillResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/create_company_response.py b/src/apideck/model/create_company_response.py new file mode 100644 index 0000000000..5c47b94d76 --- /dev/null +++ b/src/apideck/model/create_company_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_id import UnifiedId + globals()['UnifiedId'] = UnifiedId + + +class CreateCompanyResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """CreateCompanyResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """CreateCompanyResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/create_connection_response.py b/src/apideck/model/create_connection_response.py new file mode 100644 index 0000000000..4ba36196ef --- /dev/null +++ b/src/apideck/model/create_connection_response.py @@ -0,0 +1,279 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.connection import Connection + globals()['Connection'] = Connection + + +class CreateConnectionResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'data': (Connection,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, data, *args, **kwargs): # noqa: E501 + """CreateConnectionResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + data (Connection): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, data, *args, **kwargs): # noqa: E501 + """CreateConnectionResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + data (Connection): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/create_contact_response.py b/src/apideck/model/create_contact_response.py new file mode 100644 index 0000000000..41d934cdaa --- /dev/null +++ b/src/apideck/model/create_contact_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_id import UnifiedId + globals()['UnifiedId'] = UnifiedId + + +class CreateContactResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """CreateContactResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """CreateContactResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/create_credit_note_response.py b/src/apideck/model/create_credit_note_response.py new file mode 100644 index 0000000000..28f591b0e2 --- /dev/null +++ b/src/apideck/model/create_credit_note_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_id import UnifiedId + globals()['UnifiedId'] = UnifiedId + + +class CreateCreditNoteResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """CreateCreditNoteResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """CreateCreditNoteResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/create_customer_response.py b/src/apideck/model/create_customer_response.py new file mode 100644 index 0000000000..7f15c263d1 --- /dev/null +++ b/src/apideck/model/create_customer_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_id import UnifiedId + globals()['UnifiedId'] = UnifiedId + + +class CreateCustomerResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """CreateCustomerResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """CreateCustomerResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/create_customer_support_customer_response.py b/src/apideck/model/create_customer_support_customer_response.py new file mode 100644 index 0000000000..d3e5643413 --- /dev/null +++ b/src/apideck/model/create_customer_support_customer_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_id import UnifiedId + globals()['UnifiedId'] = UnifiedId + + +class CreateCustomerSupportCustomerResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """CreateCustomerSupportCustomerResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """CreateCustomerSupportCustomerResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/create_department_response.py b/src/apideck/model/create_department_response.py new file mode 100644 index 0000000000..1685117c54 --- /dev/null +++ b/src/apideck/model/create_department_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_id import UnifiedId + globals()['UnifiedId'] = UnifiedId + + +class CreateDepartmentResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """CreateDepartmentResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """CreateDepartmentResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/create_drive_group_response.py b/src/apideck/model/create_drive_group_response.py new file mode 100644 index 0000000000..829c24ba61 --- /dev/null +++ b/src/apideck/model/create_drive_group_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_id import UnifiedId + globals()['UnifiedId'] = UnifiedId + + +class CreateDriveGroupResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """CreateDriveGroupResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """CreateDriveGroupResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/create_drive_response.py b/src/apideck/model/create_drive_response.py new file mode 100644 index 0000000000..7d3d0bc144 --- /dev/null +++ b/src/apideck/model/create_drive_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_id import UnifiedId + globals()['UnifiedId'] = UnifiedId + + +class CreateDriveResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """CreateDriveResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """CreateDriveResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/create_employee_response.py b/src/apideck/model/create_employee_response.py new file mode 100644 index 0000000000..5be7c18130 --- /dev/null +++ b/src/apideck/model/create_employee_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_id import UnifiedId + globals()['UnifiedId'] = UnifiedId + + +class CreateEmployeeResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """CreateEmployeeResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """CreateEmployeeResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/create_file_request.py b/src/apideck/model/create_file_request.py new file mode 100644 index 0000000000..54c05a90ce --- /dev/null +++ b/src/apideck/model/create_file_request.py @@ -0,0 +1,269 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class CreateFileRequest(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'name': (str,), # noqa: E501 + 'parent_folder_id': (str,), # noqa: E501 + 'drive_id': (str,), # noqa: E501 + 'description': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'name': 'name', # noqa: E501 + 'parent_folder_id': 'parent_folder_id', # noqa: E501 + 'drive_id': 'drive_id', # noqa: E501 + 'description': 'description', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, name, parent_folder_id, *args, **kwargs): # noqa: E501 + """CreateFileRequest - a model defined in OpenAPI + + Args: + name (str): The name of the file. + parent_folder_id (str): The parent folder to create the new file within. + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + drive_id (str): ID of the drive to upload to.. [optional] # noqa: E501 + description (str): Optional description of the file.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.name = name + self.parent_folder_id = parent_folder_id + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, name, parent_folder_id, *args, **kwargs): # noqa: E501 + """CreateFileRequest - a model defined in OpenAPI + + Args: + name (str): The name of the file. + parent_folder_id (str): The parent folder to create the new file within. + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + drive_id (str): ID of the drive to upload to.. [optional] # noqa: E501 + description (str): Optional description of the file.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.name = name + self.parent_folder_id = parent_folder_id + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/create_file_response.py b/src/apideck/model/create_file_response.py new file mode 100644 index 0000000000..8c00378d0d --- /dev/null +++ b/src/apideck/model/create_file_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_id import UnifiedId + globals()['UnifiedId'] = UnifiedId + + +class CreateFileResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """CreateFileResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """CreateFileResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/create_folder_request.py b/src/apideck/model/create_folder_request.py new file mode 100644 index 0000000000..118a31106b --- /dev/null +++ b/src/apideck/model/create_folder_request.py @@ -0,0 +1,274 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class CreateFolderRequest(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'name': (str,), # noqa: E501 + 'parent_folder_id': (str,), # noqa: E501 + 'id': (str,), # noqa: E501 + 'description': (str,), # noqa: E501 + 'drive_id': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'name': 'name', # noqa: E501 + 'parent_folder_id': 'parent_folder_id', # noqa: E501 + 'id': 'id', # noqa: E501 + 'description': 'description', # noqa: E501 + 'drive_id': 'drive_id', # noqa: E501 + } + + read_only_vars = { + 'id', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, name, parent_folder_id, *args, **kwargs): # noqa: E501 + """CreateFolderRequest - a model defined in OpenAPI + + Args: + name (str): The name of the folder. + parent_folder_id (str): The parent folder to create the new file within. + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + description (str): Optional description of the folder.. [optional] # noqa: E501 + drive_id (str): ID of the drive to create the folder in.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.name = name + self.parent_folder_id = parent_folder_id + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, name, parent_folder_id, *args, **kwargs): # noqa: E501 + """CreateFolderRequest - a model defined in OpenAPI + + Args: + name (str): The name of the folder. + parent_folder_id (str): The parent folder to create the new file within. + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + description (str): Optional description of the folder.. [optional] # noqa: E501 + drive_id (str): ID of the drive to create the folder in.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.name = name + self.parent_folder_id = parent_folder_id + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/create_folder_response.py b/src/apideck/model/create_folder_response.py new file mode 100644 index 0000000000..bdafebf4e7 --- /dev/null +++ b/src/apideck/model/create_folder_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_id import UnifiedId + globals()['UnifiedId'] = UnifiedId + + +class CreateFolderResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """CreateFolderResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """CreateFolderResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/create_hris_company_response.py b/src/apideck/model/create_hris_company_response.py new file mode 100644 index 0000000000..a01ae5f257 --- /dev/null +++ b/src/apideck/model/create_hris_company_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_id import UnifiedId + globals()['UnifiedId'] = UnifiedId + + +class CreateHrisCompanyResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """CreateHrisCompanyResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """CreateHrisCompanyResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/create_invoice_item_response.py b/src/apideck/model/create_invoice_item_response.py new file mode 100644 index 0000000000..98f101ca0f --- /dev/null +++ b/src/apideck/model/create_invoice_item_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_id import UnifiedId + globals()['UnifiedId'] = UnifiedId + + +class CreateInvoiceItemResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """CreateInvoiceItemResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """CreateInvoiceItemResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/create_invoice_response.py b/src/apideck/model/create_invoice_response.py new file mode 100644 index 0000000000..accb0e3885 --- /dev/null +++ b/src/apideck/model/create_invoice_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.invoice_response import InvoiceResponse + globals()['InvoiceResponse'] = InvoiceResponse + + +class CreateInvoiceResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (InvoiceResponse,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """CreateInvoiceResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (InvoiceResponse): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """CreateInvoiceResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (InvoiceResponse): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/create_item_response.py b/src/apideck/model/create_item_response.py new file mode 100644 index 0000000000..ca8aeebde2 --- /dev/null +++ b/src/apideck/model/create_item_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_id import UnifiedId + globals()['UnifiedId'] = UnifiedId + + +class CreateItemResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """CreateItemResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """CreateItemResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/create_job_response.py b/src/apideck/model/create_job_response.py new file mode 100644 index 0000000000..de2beaf7ad --- /dev/null +++ b/src/apideck/model/create_job_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_id import UnifiedId + globals()['UnifiedId'] = UnifiedId + + +class CreateJobResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """CreateJobResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """CreateJobResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/create_lead_response.py b/src/apideck/model/create_lead_response.py new file mode 100644 index 0000000000..eb1043f809 --- /dev/null +++ b/src/apideck/model/create_lead_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_id import UnifiedId + globals()['UnifiedId'] = UnifiedId + + +class CreateLeadResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """CreateLeadResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """CreateLeadResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/create_ledger_account_response.py b/src/apideck/model/create_ledger_account_response.py new file mode 100644 index 0000000000..393e9ca6fa --- /dev/null +++ b/src/apideck/model/create_ledger_account_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_id import UnifiedId + globals()['UnifiedId'] = UnifiedId + + +class CreateLedgerAccountResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """CreateLedgerAccountResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """CreateLedgerAccountResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/create_location_response.py b/src/apideck/model/create_location_response.py new file mode 100644 index 0000000000..2e5389b348 --- /dev/null +++ b/src/apideck/model/create_location_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_id import UnifiedId + globals()['UnifiedId'] = UnifiedId + + +class CreateLocationResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """CreateLocationResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """CreateLocationResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/create_merchant_response.py b/src/apideck/model/create_merchant_response.py new file mode 100644 index 0000000000..02e4cecd10 --- /dev/null +++ b/src/apideck/model/create_merchant_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_id import UnifiedId + globals()['UnifiedId'] = UnifiedId + + +class CreateMerchantResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """CreateMerchantResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """CreateMerchantResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/create_message_response.py b/src/apideck/model/create_message_response.py new file mode 100644 index 0000000000..ae414211ce --- /dev/null +++ b/src/apideck/model/create_message_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_id import UnifiedId + globals()['UnifiedId'] = UnifiedId + + +class CreateMessageResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """CreateMessageResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """CreateMessageResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/create_modifier_group_response.py b/src/apideck/model/create_modifier_group_response.py new file mode 100644 index 0000000000..9268728aba --- /dev/null +++ b/src/apideck/model/create_modifier_group_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_id import UnifiedId + globals()['UnifiedId'] = UnifiedId + + +class CreateModifierGroupResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """CreateModifierGroupResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """CreateModifierGroupResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/create_modifier_response.py b/src/apideck/model/create_modifier_response.py new file mode 100644 index 0000000000..18d6533249 --- /dev/null +++ b/src/apideck/model/create_modifier_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_id import UnifiedId + globals()['UnifiedId'] = UnifiedId + + +class CreateModifierResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """CreateModifierResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """CreateModifierResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/create_note_response.py b/src/apideck/model/create_note_response.py new file mode 100644 index 0000000000..b2a593087e --- /dev/null +++ b/src/apideck/model/create_note_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_id import UnifiedId + globals()['UnifiedId'] = UnifiedId + + +class CreateNoteResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """CreateNoteResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """CreateNoteResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/create_opportunity_response.py b/src/apideck/model/create_opportunity_response.py new file mode 100644 index 0000000000..a8a62c891c --- /dev/null +++ b/src/apideck/model/create_opportunity_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_id import UnifiedId + globals()['UnifiedId'] = UnifiedId + + +class CreateOpportunityResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """CreateOpportunityResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """CreateOpportunityResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/create_order_response.py b/src/apideck/model/create_order_response.py new file mode 100644 index 0000000000..54ce30db1d --- /dev/null +++ b/src/apideck/model/create_order_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_id import UnifiedId + globals()['UnifiedId'] = UnifiedId + + +class CreateOrderResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """CreateOrderResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """CreateOrderResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/create_order_type_response.py b/src/apideck/model/create_order_type_response.py new file mode 100644 index 0000000000..463deb2113 --- /dev/null +++ b/src/apideck/model/create_order_type_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_id import UnifiedId + globals()['UnifiedId'] = UnifiedId + + +class CreateOrderTypeResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """CreateOrderTypeResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """CreateOrderTypeResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/create_payment_response.py b/src/apideck/model/create_payment_response.py new file mode 100644 index 0000000000..fd6a4e40da --- /dev/null +++ b/src/apideck/model/create_payment_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_id import UnifiedId + globals()['UnifiedId'] = UnifiedId + + +class CreatePaymentResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """CreatePaymentResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """CreatePaymentResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/create_pipeline_response.py b/src/apideck/model/create_pipeline_response.py new file mode 100644 index 0000000000..ddc294d40b --- /dev/null +++ b/src/apideck/model/create_pipeline_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_id import UnifiedId + globals()['UnifiedId'] = UnifiedId + + +class CreatePipelineResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """CreatePipelineResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """CreatePipelineResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/create_pos_payment_response.py b/src/apideck/model/create_pos_payment_response.py new file mode 100644 index 0000000000..e650cdf890 --- /dev/null +++ b/src/apideck/model/create_pos_payment_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_id import UnifiedId + globals()['UnifiedId'] = UnifiedId + + +class CreatePosPaymentResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """CreatePosPaymentResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """CreatePosPaymentResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/create_session_response.py b/src/apideck/model/create_session_response.py new file mode 100644 index 0000000000..6f4b7671c5 --- /dev/null +++ b/src/apideck/model/create_session_response.py @@ -0,0 +1,272 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.create_session_response_data import CreateSessionResponseData + globals()['CreateSessionResponseData'] = CreateSessionResponseData + + +class CreateSessionResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'data': (CreateSessionResponseData,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, data, *args, **kwargs): # noqa: E501 + """CreateSessionResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + data (CreateSessionResponseData): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, data, *args, **kwargs): # noqa: E501 + """CreateSessionResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + data (CreateSessionResponseData): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/create_session_response_data.py b/src/apideck/model/create_session_response_data.py new file mode 100644 index 0000000000..21d23e7078 --- /dev/null +++ b/src/apideck/model/create_session_response_data.py @@ -0,0 +1,263 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class CreateSessionResponseData(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'session_uri': (str,), # noqa: E501 + 'session_token': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'session_uri': 'session_uri', # noqa: E501 + 'session_token': 'session_token', # noqa: E501 + } + + read_only_vars = { + 'session_uri', # noqa: E501 + 'session_token', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, session_uri, session_token, *args, **kwargs): # noqa: E501 + """CreateSessionResponseData - a model defined in OpenAPI + + Args: + session_uri (str): + session_token (str): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.session_uri = session_uri + self.session_token = session_token + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """CreateSessionResponseData - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/create_shared_link_response.py b/src/apideck/model/create_shared_link_response.py new file mode 100644 index 0000000000..35dcc61bf2 --- /dev/null +++ b/src/apideck/model/create_shared_link_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_id import UnifiedId + globals()['UnifiedId'] = UnifiedId + + +class CreateSharedLinkResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """CreateSharedLinkResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """CreateSharedLinkResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/create_supplier_response.py b/src/apideck/model/create_supplier_response.py new file mode 100644 index 0000000000..0709b9e344 --- /dev/null +++ b/src/apideck/model/create_supplier_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_id import UnifiedId + globals()['UnifiedId'] = UnifiedId + + +class CreateSupplierResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """CreateSupplierResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """CreateSupplierResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/create_tax_rate_response.py b/src/apideck/model/create_tax_rate_response.py new file mode 100644 index 0000000000..4335f7ccc5 --- /dev/null +++ b/src/apideck/model/create_tax_rate_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_id import UnifiedId + globals()['UnifiedId'] = UnifiedId + + +class CreateTaxRateResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """CreateTaxRateResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """CreateTaxRateResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/create_tender_response.py b/src/apideck/model/create_tender_response.py new file mode 100644 index 0000000000..ad5dfb51fa --- /dev/null +++ b/src/apideck/model/create_tender_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_id import UnifiedId + globals()['UnifiedId'] = UnifiedId + + +class CreateTenderResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """CreateTenderResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """CreateTenderResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/create_time_off_request_response.py b/src/apideck/model/create_time_off_request_response.py new file mode 100644 index 0000000000..8560600058 --- /dev/null +++ b/src/apideck/model/create_time_off_request_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_id import UnifiedId + globals()['UnifiedId'] = UnifiedId + + +class CreateTimeOffRequestResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """CreateTimeOffRequestResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """CreateTimeOffRequestResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/create_upload_session_request.py b/src/apideck/model/create_upload_session_request.py new file mode 100644 index 0000000000..c1904a8223 --- /dev/null +++ b/src/apideck/model/create_upload_session_request.py @@ -0,0 +1,271 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class CreateUploadSessionRequest(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'name': (str,), # noqa: E501 + 'parent_folder_id': (str,), # noqa: E501 + 'size': (int,), # noqa: E501 + 'drive_id': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'name': 'name', # noqa: E501 + 'parent_folder_id': 'parent_folder_id', # noqa: E501 + 'size': 'size', # noqa: E501 + 'drive_id': 'drive_id', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, name, parent_folder_id, size, *args, **kwargs): # noqa: E501 + """CreateUploadSessionRequest - a model defined in OpenAPI + + Args: + name (str): The name of the file. + parent_folder_id (str): The parent folder to create the new file within. + size (int): The size of the file in bytes + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + drive_id (str): ID of the drive to upload to.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.name = name + self.parent_folder_id = parent_folder_id + self.size = size + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, name, parent_folder_id, size, *args, **kwargs): # noqa: E501 + """CreateUploadSessionRequest - a model defined in OpenAPI + + Args: + name (str): The name of the file. + parent_folder_id (str): The parent folder to create the new file within. + size (int): The size of the file in bytes + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + drive_id (str): ID of the drive to upload to.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.name = name + self.parent_folder_id = parent_folder_id + self.size = size + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/create_upload_session_response.py b/src/apideck/model/create_upload_session_response.py new file mode 100644 index 0000000000..27a7532e7e --- /dev/null +++ b/src/apideck/model/create_upload_session_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_id import UnifiedId + globals()['UnifiedId'] = UnifiedId + + +class CreateUploadSessionResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """CreateUploadSessionResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """CreateUploadSessionResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/create_user_response.py b/src/apideck/model/create_user_response.py new file mode 100644 index 0000000000..11b97433ca --- /dev/null +++ b/src/apideck/model/create_user_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_id import UnifiedId + globals()['UnifiedId'] = UnifiedId + + +class CreateUserResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """CreateUserResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """CreateUserResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/create_webhook_request.py b/src/apideck/model/create_webhook_request.py new file mode 100644 index 0000000000..c19e6e23b4 --- /dev/null +++ b/src/apideck/model/create_webhook_request.py @@ -0,0 +1,288 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.delivery_url import DeliveryUrl + from apideck.model.status import Status + from apideck.model.unified_api_id import UnifiedApiId + from apideck.model.webhook_event_type import WebhookEventType + globals()['DeliveryUrl'] = DeliveryUrl + globals()['Status'] = Status + globals()['UnifiedApiId'] = UnifiedApiId + globals()['WebhookEventType'] = WebhookEventType + + +class CreateWebhookRequest(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'unified_api': (UnifiedApiId,), # noqa: E501 + 'status': (Status,), # noqa: E501 + 'delivery_url': (DeliveryUrl,), # noqa: E501 + 'events': ([WebhookEventType],), # noqa: E501 + 'description': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'unified_api': 'unified_api', # noqa: E501 + 'status': 'status', # noqa: E501 + 'delivery_url': 'delivery_url', # noqa: E501 + 'events': 'events', # noqa: E501 + 'description': 'description', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, unified_api, status, delivery_url, events, *args, **kwargs): # noqa: E501 + """CreateWebhookRequest - a model defined in OpenAPI + + Args: + unified_api (UnifiedApiId): + status (Status): + delivery_url (DeliveryUrl): + events ([WebhookEventType]): The list of subscribed events for this webhook. [`*`] indicates that all events are enabled. + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + description (str, none_type): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.unified_api = unified_api + self.status = status + self.delivery_url = delivery_url + self.events = events + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, unified_api, status, delivery_url, events, *args, **kwargs): # noqa: E501 + """CreateWebhookRequest - a model defined in OpenAPI + + Args: + unified_api (UnifiedApiId): + status (Status): + delivery_url (DeliveryUrl): + events ([WebhookEventType]): The list of subscribed events for this webhook. [`*`] indicates that all events are enabled. + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + description (str, none_type): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.unified_api = unified_api + self.status = status + self.delivery_url = delivery_url + self.events = events + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/create_webhook_response.py b/src/apideck/model/create_webhook_response.py new file mode 100644 index 0000000000..05616eef70 --- /dev/null +++ b/src/apideck/model/create_webhook_response.py @@ -0,0 +1,279 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.webhook import Webhook + globals()['Webhook'] = Webhook + + +class CreateWebhookResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'data': (Webhook,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, data, *args, **kwargs): # noqa: E501 + """CreateWebhookResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + data (Webhook): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, data, *args, **kwargs): # noqa: E501 + """CreateWebhookResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + data (Webhook): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/credit_note.py b/src/apideck/model/credit_note.py new file mode 100644 index 0000000000..f8cf50baab --- /dev/null +++ b/src/apideck/model/credit_note.py @@ -0,0 +1,389 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.currency import Currency + from apideck.model.invoice_line_item import InvoiceLineItem + from apideck.model.linked_customer import LinkedCustomer + from apideck.model.linked_ledger_account import LinkedLedgerAccount + globals()['Currency'] = Currency + globals()['InvoiceLineItem'] = InvoiceLineItem + globals()['LinkedCustomer'] = LinkedCustomer + globals()['LinkedLedgerAccount'] = LinkedLedgerAccount + + +class CreditNote(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('status',): { + 'DRAFT': "draft", + 'AUTHORISED': "authorised", + 'PAID': "paid", + 'VOIDED': "voided", + 'DELETED': "deleted", + }, + ('type',): { + 'RECEIVABLE_CREDIT': "accounts_receivable_credit", + 'PAYABLE_CREDIT': "accounts_payable_credit", + }, + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'total_amount': (float,), # noqa: E501 + 'id': (str,), # noqa: E501 + 'number': (str, none_type,), # noqa: E501 + 'customer': (LinkedCustomer,), # noqa: E501 + 'currency': (Currency,), # noqa: E501 + 'currency_rate': (float, none_type,), # noqa: E501 + 'tax_inclusive': (bool, none_type,), # noqa: E501 + 'sub_total': (float, none_type,), # noqa: E501 + 'total_tax': (float, none_type,), # noqa: E501 + 'tax_code': (str, none_type,), # noqa: E501 + 'balance': (float, none_type,), # noqa: E501 + 'remaining_credit': (float, none_type,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'reference': (str, none_type,), # noqa: E501 + 'date_issued': (datetime,), # noqa: E501 + 'date_paid': (datetime, none_type,), # noqa: E501 + 'type': (str,), # noqa: E501 + 'account': (LinkedLedgerAccount,), # noqa: E501 + 'line_items': ([InvoiceLineItem],), # noqa: E501 + 'allocations': ([bool, date, datetime, dict, float, int, list, str, none_type],), # noqa: E501 + 'note': (str, none_type,), # noqa: E501 + 'row_version': (str, none_type,), # noqa: E501 + 'updated_by': (str, none_type,), # noqa: E501 + 'created_by': (str, none_type,), # noqa: E501 + 'updated_at': (datetime,), # noqa: E501 + 'created_at': (datetime,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'total_amount': 'total_amount', # noqa: E501 + 'id': 'id', # noqa: E501 + 'number': 'number', # noqa: E501 + 'customer': 'customer', # noqa: E501 + 'currency': 'currency', # noqa: E501 + 'currency_rate': 'currency_rate', # noqa: E501 + 'tax_inclusive': 'tax_inclusive', # noqa: E501 + 'sub_total': 'sub_total', # noqa: E501 + 'total_tax': 'total_tax', # noqa: E501 + 'tax_code': 'tax_code', # noqa: E501 + 'balance': 'balance', # noqa: E501 + 'remaining_credit': 'remaining_credit', # noqa: E501 + 'status': 'status', # noqa: E501 + 'reference': 'reference', # noqa: E501 + 'date_issued': 'date_issued', # noqa: E501 + 'date_paid': 'date_paid', # noqa: E501 + 'type': 'type', # noqa: E501 + 'account': 'account', # noqa: E501 + 'line_items': 'line_items', # noqa: E501 + 'allocations': 'allocations', # noqa: E501 + 'note': 'note', # noqa: E501 + 'row_version': 'row_version', # noqa: E501 + 'updated_by': 'updated_by', # noqa: E501 + 'created_by': 'created_by', # noqa: E501 + 'updated_at': 'updated_at', # noqa: E501 + 'created_at': 'created_at', # noqa: E501 + } + + read_only_vars = { + 'id', # noqa: E501 + 'updated_by', # noqa: E501 + 'created_by', # noqa: E501 + 'updated_at', # noqa: E501 + 'created_at', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, total_amount, *args, **kwargs): # noqa: E501 + """CreditNote - a model defined in OpenAPI + + Args: + total_amount (float): Amount of transaction + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): Unique identifier representing the entity. [optional] # noqa: E501 + number (str, none_type): Credit note number.. [optional] # noqa: E501 + customer (LinkedCustomer): [optional] # noqa: E501 + currency (Currency): [optional] # noqa: E501 + currency_rate (float, none_type): Currency Exchange Rate at the time entity was recorded/generated.. [optional] # noqa: E501 + tax_inclusive (bool, none_type): Amounts are including tax. [optional] # noqa: E501 + sub_total (float, none_type): Sub-total amount, normally before tax.. [optional] # noqa: E501 + total_tax (float, none_type): Total tax amount applied to this invoice.. [optional] # noqa: E501 + tax_code (str, none_type): Applicable tax id/code override if tax is not supplied on a line item basis.. [optional] # noqa: E501 + balance (float, none_type): The balance reflecting any payments made against the transaction.. [optional] # noqa: E501 + remaining_credit (float, none_type): Indicates the total credit amount still available to apply towards the payment.. [optional] # noqa: E501 + status (str): Status of payment. [optional] # noqa: E501 + reference (str, none_type): Optional reference message ie: Debit remittance detail.. [optional] # noqa: E501 + date_issued (datetime): Date credit note issued - YYYY:MM::DDThh:mm:ss.sTZD. [optional] # noqa: E501 + date_paid (datetime, none_type): Date credit note paid - YYYY:MM::DDThh:mm:ss.sTZD. [optional] # noqa: E501 + type (str): Type of payment. [optional] # noqa: E501 + account (LinkedLedgerAccount): [optional] # noqa: E501 + line_items ([InvoiceLineItem]): [optional] # noqa: E501 + allocations ([bool, date, datetime, dict, float, int, list, str, none_type]): [optional] # noqa: E501 + note (str, none_type): Optional note to be associated with the credit note.. [optional] # noqa: E501 + row_version (str, none_type): [optional] # noqa: E501 + updated_by (str, none_type): [optional] # noqa: E501 + created_by (str, none_type): [optional] # noqa: E501 + updated_at (datetime): [optional] # noqa: E501 + created_at (datetime): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.total_amount = total_amount + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, total_amount, *args, **kwargs): # noqa: E501 + """CreditNote - a model defined in OpenAPI + + Args: + total_amount (float): Amount of transaction + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): Unique identifier representing the entity. [optional] # noqa: E501 + number (str, none_type): Credit note number.. [optional] # noqa: E501 + customer (LinkedCustomer): [optional] # noqa: E501 + currency (Currency): [optional] # noqa: E501 + currency_rate (float, none_type): Currency Exchange Rate at the time entity was recorded/generated.. [optional] # noqa: E501 + tax_inclusive (bool, none_type): Amounts are including tax. [optional] # noqa: E501 + sub_total (float, none_type): Sub-total amount, normally before tax.. [optional] # noqa: E501 + total_tax (float, none_type): Total tax amount applied to this invoice.. [optional] # noqa: E501 + tax_code (str, none_type): Applicable tax id/code override if tax is not supplied on a line item basis.. [optional] # noqa: E501 + balance (float, none_type): The balance reflecting any payments made against the transaction.. [optional] # noqa: E501 + remaining_credit (float, none_type): Indicates the total credit amount still available to apply towards the payment.. [optional] # noqa: E501 + status (str): Status of payment. [optional] # noqa: E501 + reference (str, none_type): Optional reference message ie: Debit remittance detail.. [optional] # noqa: E501 + date_issued (datetime): Date credit note issued - YYYY:MM::DDThh:mm:ss.sTZD. [optional] # noqa: E501 + date_paid (datetime, none_type): Date credit note paid - YYYY:MM::DDThh:mm:ss.sTZD. [optional] # noqa: E501 + type (str): Type of payment. [optional] # noqa: E501 + account (LinkedLedgerAccount): [optional] # noqa: E501 + line_items ([InvoiceLineItem]): [optional] # noqa: E501 + allocations ([bool, date, datetime, dict, float, int, list, str, none_type]): [optional] # noqa: E501 + note (str, none_type): Optional note to be associated with the credit note.. [optional] # noqa: E501 + row_version (str, none_type): [optional] # noqa: E501 + updated_by (str, none_type): [optional] # noqa: E501 + created_by (str, none_type): [optional] # noqa: E501 + updated_at (datetime): [optional] # noqa: E501 + created_at (datetime): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.total_amount = total_amount + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/crm_event_type.py b/src/apideck/model/crm_event_type.py new file mode 100644 index 0000000000..0774050e77 --- /dev/null +++ b/src/apideck/model/crm_event_type.py @@ -0,0 +1,299 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class CrmEventType(ModelSimple): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('value',): { + '*': "*", + 'CRM.ACTIVITY.CREATED': "crm.activity.created", + 'CRM.ACTIVITY.UPDATED': "crm.activity.updated", + 'CRM.ACTIVITY.DELETED': "crm.activity.deleted", + 'CRM.COMPANY.CREATED': "crm.company.created", + 'CRM.COMPANY.UPDATED': "crm.company.updated", + 'CRM.COMPANY.DELETED': "crm.company.deleted", + 'CRM.CONTACT.CREATED': "crm.contact.created", + 'CRM.CONTACT.UPDATED': "crm.contact.updated", + 'CRM.CONTACT.DELETED': "crm.contact.deleted", + 'CRM.LEAD.CREATED': "crm.lead.created", + 'CRM.LEAD.UPDATED': "crm.lead.updated", + 'CRM.LEAD.DELETED': "crm.lead.deleted", + 'CRM.NOTE.CREATED': "crm.note.created", + 'CRM.NOTE.UPDATED': "crm.note.updated", + 'CRM.NOTE.DELETED': "crm.note.deleted", + 'CRM.OPPORTUNITY.CREATED': "crm.opportunity.created", + 'CRM.OPPORTUNITY.UPDATED': "crm.opportunity.updated", + 'CRM.OPPORTUNITY.DELETED': "crm.opportunity.deleted", + }, + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'value': (str,), + } + + @cached_property + def discriminator(): + return None + + + attribute_map = {} + + read_only_vars = set() + + _composed_schemas = None + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): + """CrmEventType - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] (str):, must be one of ["*", "crm.activity.created", "crm.activity.updated", "crm.activity.deleted", "crm.company.created", "crm.company.updated", "crm.company.deleted", "crm.contact.created", "crm.contact.updated", "crm.contact.deleted", "crm.lead.created", "crm.lead.updated", "crm.lead.deleted", "crm.note.created", "crm.note.updated", "crm.note.deleted", "crm.opportunity.created", "crm.opportunity.updated", "crm.opportunity.deleted", ] # noqa: E501 + + Keyword Args: + value (str):, must be one of ["*", "crm.activity.created", "crm.activity.updated", "crm.activity.deleted", "crm.company.created", "crm.company.updated", "crm.company.deleted", "crm.contact.created", "crm.contact.updated", "crm.contact.deleted", "crm.lead.created", "crm.lead.updated", "crm.lead.deleted", "crm.note.created", "crm.note.updated", "crm.note.deleted", "crm.opportunity.created", "crm.opportunity.updated", "crm.opportunity.deleted", ] # noqa: E501 + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + self.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): + """CrmEventType - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] (str):, must be one of ["*", "crm.activity.created", "crm.activity.updated", "crm.activity.deleted", "crm.company.created", "crm.company.updated", "crm.company.deleted", "crm.contact.created", "crm.contact.updated", "crm.contact.deleted", "crm.lead.created", "crm.lead.updated", "crm.lead.deleted", "crm.note.created", "crm.note.updated", "crm.note.deleted", "crm.opportunity.created", "crm.opportunity.updated", "crm.opportunity.deleted", ] # noqa: E501 + + Keyword Args: + value (str):, must be one of ["*", "crm.activity.created", "crm.activity.updated", "crm.activity.deleted", "crm.company.created", "crm.company.updated", "crm.company.deleted", "crm.contact.created", "crm.contact.updated", "crm.contact.deleted", "crm.lead.created", "crm.lead.updated", "crm.lead.deleted", "crm.note.created", "crm.note.updated", "crm.note.deleted", "crm.opportunity.created", "crm.opportunity.updated", "crm.opportunity.deleted", ] # noqa: E501 + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + self.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + return self diff --git a/src/apideck/model/currency.py b/src/apideck/model/currency.py new file mode 100644 index 0000000000..47949d7aa1 --- /dev/null +++ b/src/apideck/model/currency.py @@ -0,0 +1,463 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class Currency(ModelSimple): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('value',): { + 'None': None, + 'UNKNOWN_CURRENCY': "UNKNOWN_CURRENCY", + 'AED': "AED", + 'AFN': "AFN", + 'ALL': "ALL", + 'AMD': "AMD", + 'ANG': "ANG", + 'AOA': "AOA", + 'ARS': "ARS", + 'AUD': "AUD", + 'AWG': "AWG", + 'AZN': "AZN", + 'BAM': "BAM", + 'BBD': "BBD", + 'BDT': "BDT", + 'BGN': "BGN", + 'BHD': "BHD", + 'BIF': "BIF", + 'BMD': "BMD", + 'BND': "BND", + 'BOB': "BOB", + 'BOV': "BOV", + 'BRL': "BRL", + 'BSD': "BSD", + 'BTN': "BTN", + 'BWP': "BWP", + 'BYR': "BYR", + 'BZD': "BZD", + 'CAD': "CAD", + 'CDF': "CDF", + 'CHE': "CHE", + 'CHF': "CHF", + 'CHW': "CHW", + 'CLF': "CLF", + 'CLP': "CLP", + 'CNY': "CNY", + 'COP': "COP", + 'COU': "COU", + 'CRC': "CRC", + 'CUC': "CUC", + 'CUP': "CUP", + 'CVE': "CVE", + 'CZK': "CZK", + 'DJF': "DJF", + 'DKK': "DKK", + 'DOP': "DOP", + 'DZD': "DZD", + 'EGP': "EGP", + 'ERN': "ERN", + 'ETB': "ETB", + 'EUR': "EUR", + 'FJD': "FJD", + 'FKP': "FKP", + 'GBP': "GBP", + 'GEL': "GEL", + 'GHS': "GHS", + 'GIP': "GIP", + 'GMD': "GMD", + 'GNF': "GNF", + 'GTQ': "GTQ", + 'GYD': "GYD", + 'HKD': "HKD", + 'HNL': "HNL", + 'HRK': "HRK", + 'HTG': "HTG", + 'HUF': "HUF", + 'IDR': "IDR", + 'ILS': "ILS", + 'INR': "INR", + 'IQD': "IQD", + 'IRR': "IRR", + 'ISK': "ISK", + 'JMD': "JMD", + 'JOD': "JOD", + 'JPY': "JPY", + 'KES': "KES", + 'KGS': "KGS", + 'KHR': "KHR", + 'KMF': "KMF", + 'KPW': "KPW", + 'KRW': "KRW", + 'KWD': "KWD", + 'KYD': "KYD", + 'KZT': "KZT", + 'LAK': "LAK", + 'LBP': "LBP", + 'LKR': "LKR", + 'LRD': "LRD", + 'LSL': "LSL", + 'LTL': "LTL", + 'LVL': "LVL", + 'LYD': "LYD", + 'MAD': "MAD", + 'MDL': "MDL", + 'MGA': "MGA", + 'MKD': "MKD", + 'MMK': "MMK", + 'MNT': "MNT", + 'MOP': "MOP", + 'MRO': "MRO", + 'MUR': "MUR", + 'MVR': "MVR", + 'MWK': "MWK", + 'MXN': "MXN", + 'MXV': "MXV", + 'MYR': "MYR", + 'MZN': "MZN", + 'NAD': "NAD", + 'NGN': "NGN", + 'NIO': "NIO", + 'NOK': "NOK", + 'NPR': "NPR", + 'NZD': "NZD", + 'OMR': "OMR", + 'PAB': "PAB", + 'PEN': "PEN", + 'PGK': "PGK", + 'PHP': "PHP", + 'PKR': "PKR", + 'PLN': "PLN", + 'PYG': "PYG", + 'QAR': "QAR", + 'RON': "RON", + 'RSD': "RSD", + 'RUB': "RUB", + 'RWF': "RWF", + 'SAR': "SAR", + 'SBD': "SBD", + 'SCR': "SCR", + 'SDG': "SDG", + 'SEK': "SEK", + 'SGD': "SGD", + 'SHP': "SHP", + 'SLL': "SLL", + 'SOS': "SOS", + 'SRD': "SRD", + 'SSP': "SSP", + 'STD': "STD", + 'SVC': "SVC", + 'SYP': "SYP", + 'SZL': "SZL", + 'THB': "THB", + 'TJS': "TJS", + 'TMT': "TMT", + 'TND': "TND", + 'TOP': "TOP", + 'TRC': "TRC", + 'TRY': "TRY", + 'TTD': "TTD", + 'TWD': "TWD", + 'TZS': "TZS", + 'UAH': "UAH", + 'UGX': "UGX", + 'USD': "USD", + 'USN': "USN", + 'USS': "USS", + 'UYI': "UYI", + 'UYU': "UYU", + 'UZS': "UZS", + 'VEF': "VEF", + 'VND': "VND", + 'VUV': "VUV", + 'WST': "WST", + 'XAF': "XAF", + 'XAG': "XAG", + 'XAU': "XAU", + 'XBA': "XBA", + 'XBB': "XBB", + 'XBC': "XBC", + 'XBD': "XBD", + 'XCD': "XCD", + 'XDR': "XDR", + 'XOF': "XOF", + 'XPD': "XPD", + 'XPF': "XPF", + 'XPT': "XPT", + 'XTS': "XTS", + 'XXX': "XXX", + 'YER': "YER", + 'ZAR': "ZAR", + 'ZMK': "ZMK", + 'ZMW': "ZMW", + 'BTC': "BTC", + }, + } + + validations = { + } + + additional_properties_type = None + + _nullable = True + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'value': (str,), + } + + @cached_property + def discriminator(): + return None + + + attribute_map = {} + + read_only_vars = set() + + _composed_schemas = None + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): + """Currency - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] (str): Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).., must be one of ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRC", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", ] # noqa: E501 + + Keyword Args: + value (str): Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).., must be one of ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRC", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", ] # noqa: E501 + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + self.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): + """Currency - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] (str): Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).., must be one of ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRC", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", ] # noqa: E501 + + Keyword Args: + value (str): Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).., must be one of ["UNKNOWN_CURRENCY", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRC", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "USS", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XTS", "XXX", "YER", "ZAR", "ZMK", "ZMW", "BTC", ] # noqa: E501 + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + self.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + return self diff --git a/src/apideck/model/custom_field.py b/src/apideck/model/custom_field.py new file mode 100644 index 0000000000..72bb4bdd3f --- /dev/null +++ b/src/apideck/model/custom_field.py @@ -0,0 +1,267 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class CustomField(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'id': (str,), # noqa: E501 + 'name': (str,), # noqa: E501 + 'description': (str,), # noqa: E501 + 'value': (bool, date, datetime, dict, float, int, list, str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'name': 'name', # noqa: E501 + 'description': 'description', # noqa: E501 + 'value': 'value', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 + """CustomField - a model defined in OpenAPI + + Args: + id (str): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + name (str): Name of the custom field.. [optional] # noqa: E501 + description (str): More information about the custom field. [optional] # noqa: E501 + value (bool, date, datetime, dict, float, int, list, str, none_type): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.id = id + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, id, *args, **kwargs): # noqa: E501 + """CustomField - a model defined in OpenAPI + + Args: + id (str): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + name (str): Name of the custom field.. [optional] # noqa: E501 + description (str): More information about the custom field. [optional] # noqa: E501 + value (bool, date, datetime, dict, float, int, list, str, none_type): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.id = id + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/customer_support_customer.py b/src/apideck/model/customer_support_customer.py new file mode 100644 index 0000000000..ddbd122e7e --- /dev/null +++ b/src/apideck/model/customer_support_customer.py @@ -0,0 +1,338 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.address import Address + from apideck.model.bank_account import BankAccount + from apideck.model.currency import Currency + from apideck.model.email import Email + from apideck.model.phone_number import PhoneNumber + globals()['Address'] = Address + globals()['BankAccount'] = BankAccount + globals()['Currency'] = Currency + globals()['Email'] = Email + globals()['PhoneNumber'] = PhoneNumber + + +class CustomerSupportCustomer(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('status',): { + 'None': None, + 'ACTIVE': "active", + 'ARCHIVED': "archived", + 'GDPR-ERASURE-REQUEST': "gdpr-erasure-request", + 'UNKNOWN': "unknown", + }, + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'id': (str,), # noqa: E501 + 'company_name': (str, none_type,), # noqa: E501 + 'first_name': (str, none_type,), # noqa: E501 + 'last_name': (str, none_type,), # noqa: E501 + 'individual': (bool, none_type,), # noqa: E501 + 'addresses': ([Address],), # noqa: E501 + 'notes': (str, none_type,), # noqa: E501 + 'phone_numbers': ([PhoneNumber],), # noqa: E501 + 'emails': ([Email],), # noqa: E501 + 'tax_number': (str, none_type,), # noqa: E501 + 'currency': (Currency,), # noqa: E501 + 'bank_accounts': (BankAccount,), # noqa: E501 + 'status': (str, none_type,), # noqa: E501 + 'updated_by': (str, none_type,), # noqa: E501 + 'created_by': (str, none_type,), # noqa: E501 + 'updated_at': (datetime,), # noqa: E501 + 'created_at': (datetime,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'company_name': 'company_name', # noqa: E501 + 'first_name': 'first_name', # noqa: E501 + 'last_name': 'last_name', # noqa: E501 + 'individual': 'individual', # noqa: E501 + 'addresses': 'addresses', # noqa: E501 + 'notes': 'notes', # noqa: E501 + 'phone_numbers': 'phone_numbers', # noqa: E501 + 'emails': 'emails', # noqa: E501 + 'tax_number': 'tax_number', # noqa: E501 + 'currency': 'currency', # noqa: E501 + 'bank_accounts': 'bank_accounts', # noqa: E501 + 'status': 'status', # noqa: E501 + 'updated_by': 'updated_by', # noqa: E501 + 'created_by': 'created_by', # noqa: E501 + 'updated_at': 'updated_at', # noqa: E501 + 'created_at': 'created_at', # noqa: E501 + } + + read_only_vars = { + 'id', # noqa: E501 + 'updated_by', # noqa: E501 + 'created_by', # noqa: E501 + 'updated_at', # noqa: E501 + 'created_at', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """CustomerSupportCustomer - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + company_name (str, none_type): [optional] # noqa: E501 + first_name (str, none_type): [optional] # noqa: E501 + last_name (str, none_type): [optional] # noqa: E501 + individual (bool, none_type): [optional] # noqa: E501 + addresses ([Address]): [optional] # noqa: E501 + notes (str, none_type): [optional] # noqa: E501 + phone_numbers ([PhoneNumber]): [optional] # noqa: E501 + emails ([Email]): [optional] # noqa: E501 + tax_number (str, none_type): [optional] # noqa: E501 + currency (Currency): [optional] # noqa: E501 + bank_accounts (BankAccount): [optional] # noqa: E501 + status (str, none_type): Customer status. [optional] # noqa: E501 + updated_by (str, none_type): [optional] # noqa: E501 + created_by (str, none_type): [optional] # noqa: E501 + updated_at (datetime): [optional] # noqa: E501 + created_at (datetime): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """CustomerSupportCustomer - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + company_name (str, none_type): [optional] # noqa: E501 + first_name (str, none_type): [optional] # noqa: E501 + last_name (str, none_type): [optional] # noqa: E501 + individual (bool, none_type): [optional] # noqa: E501 + addresses ([Address]): [optional] # noqa: E501 + notes (str, none_type): [optional] # noqa: E501 + phone_numbers ([PhoneNumber]): [optional] # noqa: E501 + emails ([Email]): [optional] # noqa: E501 + tax_number (str, none_type): [optional] # noqa: E501 + currency (Currency): [optional] # noqa: E501 + bank_accounts (BankAccount): [optional] # noqa: E501 + status (str, none_type): Customer status. [optional] # noqa: E501 + updated_by (str, none_type): [optional] # noqa: E501 + created_by (str, none_type): [optional] # noqa: E501 + updated_at (datetime): [optional] # noqa: E501 + created_at (datetime): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/customers_filter.py b/src/apideck/model/customers_filter.py new file mode 100644 index 0000000000..84a7d47e89 --- /dev/null +++ b/src/apideck/model/customers_filter.py @@ -0,0 +1,265 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class CustomersFilter(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'company_name': (str,), # noqa: E501 + 'display_name': (str,), # noqa: E501 + 'first_name': (str,), # noqa: E501 + 'last_name': (str,), # noqa: E501 + 'email': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'company_name': 'company_name', # noqa: E501 + 'display_name': 'display_name', # noqa: E501 + 'first_name': 'first_name', # noqa: E501 + 'last_name': 'last_name', # noqa: E501 + 'email': 'email', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """CustomersFilter - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + company_name (str): Company Name of customer to search for. [optional] # noqa: E501 + display_name (str): Display Name of customer to search for. [optional] # noqa: E501 + first_name (str): First name of customer to search for. [optional] # noqa: E501 + last_name (str): Last name of customer to search for. [optional] # noqa: E501 + email (str): Email of customer to search for. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """CustomersFilter - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + company_name (str): Company Name of customer to search for. [optional] # noqa: E501 + display_name (str): Display Name of customer to search for. [optional] # noqa: E501 + first_name (str): First name of customer to search for. [optional] # noqa: E501 + last_name (str): Last name of customer to search for. [optional] # noqa: E501 + email (str): Email of customer to search for. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/deduction.py b/src/apideck/model/deduction.py new file mode 100644 index 0000000000..3bbe23c720 --- /dev/null +++ b/src/apideck/model/deduction.py @@ -0,0 +1,259 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class Deduction(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'name': (str,), # noqa: E501 + 'amount': (float,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'name': 'name', # noqa: E501 + 'amount': 'amount', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """Deduction - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + name (str): The name of the deduction.. [optional] # noqa: E501 + amount (float): The amount deducted.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """Deduction - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + name (str): The name of the deduction.. [optional] # noqa: E501 + amount (float): The amount deducted.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/delete_activity_response.py b/src/apideck/model/delete_activity_response.py new file mode 100644 index 0000000000..1a336fbc4a --- /dev/null +++ b/src/apideck/model/delete_activity_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_id import UnifiedId + globals()['UnifiedId'] = UnifiedId + + +class DeleteActivityResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """DeleteActivityResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """DeleteActivityResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/delete_bill_response.py b/src/apideck/model/delete_bill_response.py new file mode 100644 index 0000000000..84d8b00acf --- /dev/null +++ b/src/apideck/model/delete_bill_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_id import UnifiedId + globals()['UnifiedId'] = UnifiedId + + +class DeleteBillResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """DeleteBillResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """DeleteBillResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/delete_company_response.py b/src/apideck/model/delete_company_response.py new file mode 100644 index 0000000000..72d541d832 --- /dev/null +++ b/src/apideck/model/delete_company_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_id import UnifiedId + globals()['UnifiedId'] = UnifiedId + + +class DeleteCompanyResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """DeleteCompanyResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """DeleteCompanyResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/delete_contact_response.py b/src/apideck/model/delete_contact_response.py new file mode 100644 index 0000000000..62f644a955 --- /dev/null +++ b/src/apideck/model/delete_contact_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_id import UnifiedId + globals()['UnifiedId'] = UnifiedId + + +class DeleteContactResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """DeleteContactResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """DeleteContactResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/delete_credit_note_response.py b/src/apideck/model/delete_credit_note_response.py new file mode 100644 index 0000000000..ee2a5470e3 --- /dev/null +++ b/src/apideck/model/delete_credit_note_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_id import UnifiedId + globals()['UnifiedId'] = UnifiedId + + +class DeleteCreditNoteResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """DeleteCreditNoteResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """DeleteCreditNoteResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/delete_customer_response.py b/src/apideck/model/delete_customer_response.py new file mode 100644 index 0000000000..415610411a --- /dev/null +++ b/src/apideck/model/delete_customer_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_id import UnifiedId + globals()['UnifiedId'] = UnifiedId + + +class DeleteCustomerResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """DeleteCustomerResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """DeleteCustomerResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/delete_customer_support_customer_response.py b/src/apideck/model/delete_customer_support_customer_response.py new file mode 100644 index 0000000000..399a77014e --- /dev/null +++ b/src/apideck/model/delete_customer_support_customer_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_id import UnifiedId + globals()['UnifiedId'] = UnifiedId + + +class DeleteCustomerSupportCustomerResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """DeleteCustomerSupportCustomerResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """DeleteCustomerSupportCustomerResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/delete_department_response.py b/src/apideck/model/delete_department_response.py new file mode 100644 index 0000000000..430dd0be5e --- /dev/null +++ b/src/apideck/model/delete_department_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_id import UnifiedId + globals()['UnifiedId'] = UnifiedId + + +class DeleteDepartmentResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """DeleteDepartmentResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """DeleteDepartmentResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/delete_drive_group_response.py b/src/apideck/model/delete_drive_group_response.py new file mode 100644 index 0000000000..859e913107 --- /dev/null +++ b/src/apideck/model/delete_drive_group_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_id import UnifiedId + globals()['UnifiedId'] = UnifiedId + + +class DeleteDriveGroupResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """DeleteDriveGroupResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """DeleteDriveGroupResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/delete_drive_response.py b/src/apideck/model/delete_drive_response.py new file mode 100644 index 0000000000..e36cba93cf --- /dev/null +++ b/src/apideck/model/delete_drive_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_id import UnifiedId + globals()['UnifiedId'] = UnifiedId + + +class DeleteDriveResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """DeleteDriveResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """DeleteDriveResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/delete_employee_response.py b/src/apideck/model/delete_employee_response.py new file mode 100644 index 0000000000..6663ee6bf5 --- /dev/null +++ b/src/apideck/model/delete_employee_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_id import UnifiedId + globals()['UnifiedId'] = UnifiedId + + +class DeleteEmployeeResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """DeleteEmployeeResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """DeleteEmployeeResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/delete_file_response.py b/src/apideck/model/delete_file_response.py new file mode 100644 index 0000000000..198228b3f1 --- /dev/null +++ b/src/apideck/model/delete_file_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_id import UnifiedId + globals()['UnifiedId'] = UnifiedId + + +class DeleteFileResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """DeleteFileResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """DeleteFileResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/delete_folder_response.py b/src/apideck/model/delete_folder_response.py new file mode 100644 index 0000000000..3cfb9ff542 --- /dev/null +++ b/src/apideck/model/delete_folder_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_id import UnifiedId + globals()['UnifiedId'] = UnifiedId + + +class DeleteFolderResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """DeleteFolderResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """DeleteFolderResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/delete_hris_company_response.py b/src/apideck/model/delete_hris_company_response.py new file mode 100644 index 0000000000..a56d952cc9 --- /dev/null +++ b/src/apideck/model/delete_hris_company_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_id import UnifiedId + globals()['UnifiedId'] = UnifiedId + + +class DeleteHrisCompanyResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """DeleteHrisCompanyResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """DeleteHrisCompanyResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/delete_invoice_item_response.py b/src/apideck/model/delete_invoice_item_response.py new file mode 100644 index 0000000000..0da5da6fb2 --- /dev/null +++ b/src/apideck/model/delete_invoice_item_response.py @@ -0,0 +1,278 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class DeleteInvoiceItemResponse(ModelSimple): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'value': (DeleteTaxRateResponse,), + } + + @cached_property + def discriminator(): + return None + + + attribute_map = {} + + read_only_vars = set() + + _composed_schemas = None + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): + """DeleteInvoiceItemResponse - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] (DeleteTaxRateResponse): # noqa: E501 + + Keyword Args: + value (DeleteTaxRateResponse): # noqa: E501 + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + self.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): + """DeleteInvoiceItemResponse - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] (DeleteTaxRateResponse): # noqa: E501 + + Keyword Args: + value (DeleteTaxRateResponse): # noqa: E501 + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + self.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + return self diff --git a/src/apideck/model/delete_invoice_response.py b/src/apideck/model/delete_invoice_response.py new file mode 100644 index 0000000000..cc5374fe79 --- /dev/null +++ b/src/apideck/model/delete_invoice_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.invoice_response import InvoiceResponse + globals()['InvoiceResponse'] = InvoiceResponse + + +class DeleteInvoiceResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (InvoiceResponse,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """DeleteInvoiceResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (InvoiceResponse): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """DeleteInvoiceResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (InvoiceResponse): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/delete_item_response.py b/src/apideck/model/delete_item_response.py new file mode 100644 index 0000000000..10ba4cc40b --- /dev/null +++ b/src/apideck/model/delete_item_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_id import UnifiedId + globals()['UnifiedId'] = UnifiedId + + +class DeleteItemResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """DeleteItemResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """DeleteItemResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/delete_job_response.py b/src/apideck/model/delete_job_response.py new file mode 100644 index 0000000000..39fac911a6 --- /dev/null +++ b/src/apideck/model/delete_job_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_id import UnifiedId + globals()['UnifiedId'] = UnifiedId + + +class DeleteJobResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """DeleteJobResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """DeleteJobResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/delete_lead_response.py b/src/apideck/model/delete_lead_response.py new file mode 100644 index 0000000000..54abbd7dfc --- /dev/null +++ b/src/apideck/model/delete_lead_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_id import UnifiedId + globals()['UnifiedId'] = UnifiedId + + +class DeleteLeadResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """DeleteLeadResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """DeleteLeadResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/delete_ledger_account_response.py b/src/apideck/model/delete_ledger_account_response.py new file mode 100644 index 0000000000..f9aa9d4122 --- /dev/null +++ b/src/apideck/model/delete_ledger_account_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_id import UnifiedId + globals()['UnifiedId'] = UnifiedId + + +class DeleteLedgerAccountResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """DeleteLedgerAccountResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """DeleteLedgerAccountResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/delete_location_response.py b/src/apideck/model/delete_location_response.py new file mode 100644 index 0000000000..b4ea36da59 --- /dev/null +++ b/src/apideck/model/delete_location_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_id import UnifiedId + globals()['UnifiedId'] = UnifiedId + + +class DeleteLocationResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """DeleteLocationResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """DeleteLocationResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/delete_merchant_response.py b/src/apideck/model/delete_merchant_response.py new file mode 100644 index 0000000000..420475ef2b --- /dev/null +++ b/src/apideck/model/delete_merchant_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_id import UnifiedId + globals()['UnifiedId'] = UnifiedId + + +class DeleteMerchantResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """DeleteMerchantResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """DeleteMerchantResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/delete_message_response.py b/src/apideck/model/delete_message_response.py new file mode 100644 index 0000000000..c30695e42b --- /dev/null +++ b/src/apideck/model/delete_message_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_id import UnifiedId + globals()['UnifiedId'] = UnifiedId + + +class DeleteMessageResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """DeleteMessageResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """DeleteMessageResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/delete_modifier_group_response.py b/src/apideck/model/delete_modifier_group_response.py new file mode 100644 index 0000000000..bd1756b9e6 --- /dev/null +++ b/src/apideck/model/delete_modifier_group_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_id import UnifiedId + globals()['UnifiedId'] = UnifiedId + + +class DeleteModifierGroupResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """DeleteModifierGroupResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """DeleteModifierGroupResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/delete_modifier_response.py b/src/apideck/model/delete_modifier_response.py new file mode 100644 index 0000000000..1f4d4d806e --- /dev/null +++ b/src/apideck/model/delete_modifier_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_id import UnifiedId + globals()['UnifiedId'] = UnifiedId + + +class DeleteModifierResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """DeleteModifierResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """DeleteModifierResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/delete_note_response.py b/src/apideck/model/delete_note_response.py new file mode 100644 index 0000000000..ce7bd3b255 --- /dev/null +++ b/src/apideck/model/delete_note_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_id import UnifiedId + globals()['UnifiedId'] = UnifiedId + + +class DeleteNoteResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """DeleteNoteResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """DeleteNoteResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/delete_opportunity_response.py b/src/apideck/model/delete_opportunity_response.py new file mode 100644 index 0000000000..53ab351f67 --- /dev/null +++ b/src/apideck/model/delete_opportunity_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_id import UnifiedId + globals()['UnifiedId'] = UnifiedId + + +class DeleteOpportunityResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """DeleteOpportunityResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """DeleteOpportunityResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/delete_order_response.py b/src/apideck/model/delete_order_response.py new file mode 100644 index 0000000000..87a7d80478 --- /dev/null +++ b/src/apideck/model/delete_order_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_id import UnifiedId + globals()['UnifiedId'] = UnifiedId + + +class DeleteOrderResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """DeleteOrderResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """DeleteOrderResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/delete_order_type_response.py b/src/apideck/model/delete_order_type_response.py new file mode 100644 index 0000000000..c75b042d44 --- /dev/null +++ b/src/apideck/model/delete_order_type_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_id import UnifiedId + globals()['UnifiedId'] = UnifiedId + + +class DeleteOrderTypeResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """DeleteOrderTypeResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """DeleteOrderTypeResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/delete_payment_response.py b/src/apideck/model/delete_payment_response.py new file mode 100644 index 0000000000..0d2f004dc6 --- /dev/null +++ b/src/apideck/model/delete_payment_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_id import UnifiedId + globals()['UnifiedId'] = UnifiedId + + +class DeletePaymentResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """DeletePaymentResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """DeletePaymentResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/delete_pipeline_response.py b/src/apideck/model/delete_pipeline_response.py new file mode 100644 index 0000000000..efe9cd2d45 --- /dev/null +++ b/src/apideck/model/delete_pipeline_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_id import UnifiedId + globals()['UnifiedId'] = UnifiedId + + +class DeletePipelineResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """DeletePipelineResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """DeletePipelineResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/delete_pos_payment_response.py b/src/apideck/model/delete_pos_payment_response.py new file mode 100644 index 0000000000..72f106daea --- /dev/null +++ b/src/apideck/model/delete_pos_payment_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_id import UnifiedId + globals()['UnifiedId'] = UnifiedId + + +class DeletePosPaymentResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """DeletePosPaymentResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """DeletePosPaymentResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/delete_shared_link_response.py b/src/apideck/model/delete_shared_link_response.py new file mode 100644 index 0000000000..cf3c3b9bd5 --- /dev/null +++ b/src/apideck/model/delete_shared_link_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_id import UnifiedId + globals()['UnifiedId'] = UnifiedId + + +class DeleteSharedLinkResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """DeleteSharedLinkResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """DeleteSharedLinkResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/delete_supplier_response.py b/src/apideck/model/delete_supplier_response.py new file mode 100644 index 0000000000..a7173df743 --- /dev/null +++ b/src/apideck/model/delete_supplier_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_id import UnifiedId + globals()['UnifiedId'] = UnifiedId + + +class DeleteSupplierResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """DeleteSupplierResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """DeleteSupplierResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/delete_tax_rate_response.py b/src/apideck/model/delete_tax_rate_response.py new file mode 100644 index 0000000000..182a087506 --- /dev/null +++ b/src/apideck/model/delete_tax_rate_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_id import UnifiedId + globals()['UnifiedId'] = UnifiedId + + +class DeleteTaxRateResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """DeleteTaxRateResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """DeleteTaxRateResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/delete_tender_response.py b/src/apideck/model/delete_tender_response.py new file mode 100644 index 0000000000..3ff7c9027d --- /dev/null +++ b/src/apideck/model/delete_tender_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_id import UnifiedId + globals()['UnifiedId'] = UnifiedId + + +class DeleteTenderResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """DeleteTenderResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """DeleteTenderResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/delete_time_off_request_response.py b/src/apideck/model/delete_time_off_request_response.py new file mode 100644 index 0000000000..4e2dcd3c96 --- /dev/null +++ b/src/apideck/model/delete_time_off_request_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_id import UnifiedId + globals()['UnifiedId'] = UnifiedId + + +class DeleteTimeOffRequestResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """DeleteTimeOffRequestResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """DeleteTimeOffRequestResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/delete_upload_session_response.py b/src/apideck/model/delete_upload_session_response.py new file mode 100644 index 0000000000..2c5c76eb03 --- /dev/null +++ b/src/apideck/model/delete_upload_session_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_id import UnifiedId + globals()['UnifiedId'] = UnifiedId + + +class DeleteUploadSessionResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """DeleteUploadSessionResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """DeleteUploadSessionResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/delete_user_response.py b/src/apideck/model/delete_user_response.py new file mode 100644 index 0000000000..59aa92a7da --- /dev/null +++ b/src/apideck/model/delete_user_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_id import UnifiedId + globals()['UnifiedId'] = UnifiedId + + +class DeleteUserResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """DeleteUserResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """DeleteUserResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/delete_webhook_response.py b/src/apideck/model/delete_webhook_response.py new file mode 100644 index 0000000000..761b547a29 --- /dev/null +++ b/src/apideck/model/delete_webhook_response.py @@ -0,0 +1,279 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.webhook import Webhook + globals()['Webhook'] = Webhook + + +class DeleteWebhookResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'data': (Webhook,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, data, *args, **kwargs): # noqa: E501 + """DeleteWebhookResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + data (Webhook): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, data, *args, **kwargs): # noqa: E501 + """DeleteWebhookResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + data (Webhook): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/delivery_url.py b/src/apideck/model/delivery_url.py new file mode 100644 index 0000000000..e7487d9e80 --- /dev/null +++ b/src/apideck/model/delivery_url.py @@ -0,0 +1,283 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class DeliveryUrl(ModelSimple): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + ('value',): { + 'regex': { + 'pattern': r'', # noqa: E501 + }, + }, + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'value': (str,), + } + + @cached_property + def discriminator(): + return None + + + attribute_map = {} + + read_only_vars = set() + + _composed_schemas = None + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): + """DeliveryUrl - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] (str): The delivery url of the webhook endpoint.. # noqa: E501 + + Keyword Args: + value (str): The delivery url of the webhook endpoint.. # noqa: E501 + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + self.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): + """DeliveryUrl - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] (str): The delivery url of the webhook endpoint.. # noqa: E501 + + Keyword Args: + value (str): The delivery url of the webhook endpoint.. # noqa: E501 + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + self.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + return self diff --git a/src/apideck/model/department.py b/src/apideck/model/department.py new file mode 100644 index 0000000000..29267ed001 --- /dev/null +++ b/src/apideck/model/department.py @@ -0,0 +1,282 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class Department(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'id': (str,), # noqa: E501 + 'name': (str, none_type,), # noqa: E501 + 'code': (str, none_type,), # noqa: E501 + 'description': (str, none_type,), # noqa: E501 + 'updated_by': (str, none_type,), # noqa: E501 + 'created_by': (str, none_type,), # noqa: E501 + 'updated_at': (datetime,), # noqa: E501 + 'created_at': (datetime,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'name': 'name', # noqa: E501 + 'code': 'code', # noqa: E501 + 'description': 'description', # noqa: E501 + 'updated_by': 'updated_by', # noqa: E501 + 'created_by': 'created_by', # noqa: E501 + 'updated_at': 'updated_at', # noqa: E501 + 'created_at': 'created_at', # noqa: E501 + } + + read_only_vars = { + 'id', # noqa: E501 + 'updated_by', # noqa: E501 + 'created_by', # noqa: E501 + 'updated_at', # noqa: E501 + 'created_at', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """Department - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + name (str, none_type): Department name. [optional] # noqa: E501 + code (str, none_type): [optional] # noqa: E501 + description (str, none_type): [optional] # noqa: E501 + updated_by (str, none_type): [optional] # noqa: E501 + created_by (str, none_type): [optional] # noqa: E501 + updated_at (datetime): [optional] # noqa: E501 + created_at (datetime): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """Department - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + name (str, none_type): Department name. [optional] # noqa: E501 + code (str, none_type): [optional] # noqa: E501 + description (str, none_type): [optional] # noqa: E501 + updated_by (str, none_type): [optional] # noqa: E501 + created_by (str, none_type): [optional] # noqa: E501 + updated_at (datetime): [optional] # noqa: E501 + created_at (datetime): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/drive.py b/src/apideck/model/drive.py new file mode 100644 index 0000000000..ab67f95e13 --- /dev/null +++ b/src/apideck/model/drive.py @@ -0,0 +1,283 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class Drive(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'id': (str,), # noqa: E501 + 'name': (str,), # noqa: E501 + 'description': (str, none_type,), # noqa: E501 + 'updated_by': (str, none_type,), # noqa: E501 + 'created_by': (str, none_type,), # noqa: E501 + 'updated_at': (datetime,), # noqa: E501 + 'created_at': (datetime,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'name': 'name', # noqa: E501 + 'description': 'description', # noqa: E501 + 'updated_by': 'updated_by', # noqa: E501 + 'created_by': 'created_by', # noqa: E501 + 'updated_at': 'updated_at', # noqa: E501 + 'created_at': 'created_at', # noqa: E501 + } + + read_only_vars = { + 'id', # noqa: E501 + 'updated_by', # noqa: E501 + 'created_by', # noqa: E501 + 'updated_at', # noqa: E501 + 'created_at', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, id, name, *args, **kwargs): # noqa: E501 + """Drive - a model defined in OpenAPI + + Args: + id (str): + name (str): The name of the drive + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + description (str, none_type): [optional] # noqa: E501 + updated_by (str, none_type): [optional] # noqa: E501 + created_by (str, none_type): [optional] # noqa: E501 + updated_at (datetime): [optional] # noqa: E501 + created_at (datetime): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.id = id + self.name = name + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, name, *args, **kwargs): # noqa: E501 + """Drive - a model defined in OpenAPI + + name (str): The name of the drive + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + description (str, none_type): [optional] # noqa: E501 + updated_by (str, none_type): [optional] # noqa: E501 + created_by (str, none_type): [optional] # noqa: E501 + updated_at (datetime): [optional] # noqa: E501 + created_at (datetime): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.name = name + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/drive_group.py b/src/apideck/model/drive_group.py new file mode 100644 index 0000000000..48c0037689 --- /dev/null +++ b/src/apideck/model/drive_group.py @@ -0,0 +1,287 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class DriveGroup(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'id': (str,), # noqa: E501 + 'name': (str,), # noqa: E501 + 'display_name': (str,), # noqa: E501 + 'description': (str, none_type,), # noqa: E501 + 'updated_by': (str, none_type,), # noqa: E501 + 'created_by': (str, none_type,), # noqa: E501 + 'updated_at': (datetime,), # noqa: E501 + 'created_at': (datetime,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'name': 'name', # noqa: E501 + 'display_name': 'display_name', # noqa: E501 + 'description': 'description', # noqa: E501 + 'updated_by': 'updated_by', # noqa: E501 + 'created_by': 'created_by', # noqa: E501 + 'updated_at': 'updated_at', # noqa: E501 + 'created_at': 'created_at', # noqa: E501 + } + + read_only_vars = { + 'id', # noqa: E501 + 'updated_by', # noqa: E501 + 'created_by', # noqa: E501 + 'updated_at', # noqa: E501 + 'created_at', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, id, name, *args, **kwargs): # noqa: E501 + """DriveGroup - a model defined in OpenAPI + + Args: + id (str): + name (str): The name of the drive group + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + display_name (str): The display name of the drive group. [optional] # noqa: E501 + description (str, none_type): [optional] # noqa: E501 + updated_by (str, none_type): [optional] # noqa: E501 + created_by (str, none_type): [optional] # noqa: E501 + updated_at (datetime): [optional] # noqa: E501 + created_at (datetime): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.id = id + self.name = name + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, name, *args, **kwargs): # noqa: E501 + """DriveGroup - a model defined in OpenAPI + + name (str): The name of the drive group + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + display_name (str): The display name of the drive group. [optional] # noqa: E501 + description (str, none_type): [optional] # noqa: E501 + updated_by (str, none_type): [optional] # noqa: E501 + created_by (str, none_type): [optional] # noqa: E501 + updated_at (datetime): [optional] # noqa: E501 + created_at (datetime): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.name = name + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/drive_groups_filter.py b/src/apideck/model/drive_groups_filter.py new file mode 100644 index 0000000000..109e51e0e6 --- /dev/null +++ b/src/apideck/model/drive_groups_filter.py @@ -0,0 +1,249 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class DriveGroupsFilter(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'parent_group_id': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'parent_group_id': 'parent_group_id', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """DriveGroupsFilter - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + parent_group_id (str): ID of the drive group to filter on. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """DriveGroupsFilter - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + parent_group_id (str): ID of the drive group to filter on. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/drives_filter.py b/src/apideck/model/drives_filter.py new file mode 100644 index 0000000000..24fe1d2bfc --- /dev/null +++ b/src/apideck/model/drives_filter.py @@ -0,0 +1,249 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class DrivesFilter(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'group_id': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'group_id': 'group_id', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """DrivesFilter - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + group_id (str): ID of the drive group to filter on. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """DrivesFilter - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + group_id (str): ID of the drive group to filter on. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/email.py b/src/apideck/model/email.py new file mode 100644 index 0000000000..8aa0c2672d --- /dev/null +++ b/src/apideck/model/email.py @@ -0,0 +1,274 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class Email(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('type',): { + 'PRIMARY': "primary", + 'SECONDARY': "secondary", + 'WORK': "work", + 'PERSONAL': "personal", + 'BILLING': "billing", + 'OTHER': "other", + }, + } + + validations = { + ('email',): { + 'min_length': 1, + }, + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'email': (str,), # noqa: E501 + 'id': (str,), # noqa: E501 + 'type': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'email': 'email', # noqa: E501 + 'id': 'id', # noqa: E501 + 'type': 'type', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, email, *args, **kwargs): # noqa: E501 + """Email - a model defined in OpenAPI + + Args: + email (str): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + type (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.email = email + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, email, *args, **kwargs): # noqa: E501 + """Email - a model defined in OpenAPI + + Args: + email (str): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + type (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.email = email + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/employee.py b/src/apideck/model/employee.py new file mode 100644 index 0000000000..dfb179bd3f --- /dev/null +++ b/src/apideck/model/employee.py @@ -0,0 +1,537 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.address import Address + from apideck.model.applicant_social_links import ApplicantSocialLinks + from apideck.model.custom_field import CustomField + from apideck.model.email import Email + from apideck.model.employee_compensations import EmployeeCompensations + from apideck.model.employee_employment_role import EmployeeEmploymentRole + from apideck.model.employee_jobs import EmployeeJobs + from apideck.model.employee_manager import EmployeeManager + from apideck.model.employee_partner import EmployeePartner + from apideck.model.employee_team import EmployeeTeam + from apideck.model.gender import Gender + from apideck.model.phone_number import PhoneNumber + globals()['Address'] = Address + globals()['ApplicantSocialLinks'] = ApplicantSocialLinks + globals()['CustomField'] = CustomField + globals()['Email'] = Email + globals()['EmployeeCompensations'] = EmployeeCompensations + globals()['EmployeeEmploymentRole'] = EmployeeEmploymentRole + globals()['EmployeeJobs'] = EmployeeJobs + globals()['EmployeeManager'] = EmployeeManager + globals()['EmployeePartner'] = EmployeePartner + globals()['EmployeeTeam'] = EmployeeTeam + globals()['Gender'] = Gender + globals()['PhoneNumber'] = PhoneNumber + + +class Employee(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('leaving_reason',): { + 'None': None, + 'DISMISSED': "dismissed", + 'RESIGNED': "resigned", + 'REDUNDANCY': "redundancy", + 'OTHER': "other", + }, + ('employment_status',): { + 'None': None, + 'ACTIVE': "active", + 'INACTIVE': "inactive", + 'TERMINATED': "terminated", + 'OTHER': "other", + }, + } + + validations = { + ('country_of_birth',): { + 'max_length': 2, + 'min_length': 2, + }, + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'id': (str,), # noqa: E501 + 'first_name': (str, none_type,), # noqa: E501 + 'last_name': (str, none_type,), # noqa: E501 + 'middle_name': (str, none_type,), # noqa: E501 + 'display_name': (str, none_type,), # noqa: E501 + 'preferred_name': (str, none_type,), # noqa: E501 + 'initials': (str, none_type,), # noqa: E501 + 'salutation': (str, none_type,), # noqa: E501 + 'title': (str, none_type,), # noqa: E501 + 'marital_status': (str, none_type,), # noqa: E501 + 'partner': (EmployeePartner,), # noqa: E501 + 'division': (str, none_type,), # noqa: E501 + 'division_id': (str, none_type,), # noqa: E501 + 'department': (str, none_type,), # noqa: E501 + 'department_id': (str, none_type,), # noqa: E501 + 'team': (EmployeeTeam,), # noqa: E501 + 'company_id': (str, none_type,), # noqa: E501 + 'company_name': (str, none_type,), # noqa: E501 + 'employment_start_date': (str, none_type,), # noqa: E501 + 'employment_end_date': (str, none_type,), # noqa: E501 + 'leaving_reason': (str, none_type,), # noqa: E501 + 'employee_number': (str, none_type,), # noqa: E501 + 'employment_status': (str, none_type,), # noqa: E501 + 'employment_role': (EmployeeEmploymentRole,), # noqa: E501 + 'manager': (EmployeeManager,), # noqa: E501 + 'direct_reports': ([str], none_type,), # noqa: E501 + 'social_security_number': (str, none_type,), # noqa: E501 + 'birthday': (date, none_type,), # noqa: E501 + 'deceased_on': (date, none_type,), # noqa: E501 + 'country_of_birth': (str, none_type,), # noqa: E501 + 'description': (str, none_type,), # noqa: E501 + 'gender': (Gender,), # noqa: E501 + 'pronouns': (str, none_type,), # noqa: E501 + 'preferred_language': (str, none_type,), # noqa: E501 + 'languages': ([str, none_type],), # noqa: E501 + 'nationalities': ([str, none_type],), # noqa: E501 + 'photo_url': (str, none_type,), # noqa: E501 + 'timezone': (str, none_type,), # noqa: E501 + 'source': (str, none_type,), # noqa: E501 + 'source_id': (str, none_type,), # noqa: E501 + 'record_url': (str, none_type,), # noqa: E501 + 'jobs': ([EmployeeJobs],), # noqa: E501 + 'compensations': ([EmployeeCompensations],), # noqa: E501 + 'works_remote': (bool, none_type,), # noqa: E501 + 'addresses': ([Address],), # noqa: E501 + 'phone_numbers': ([PhoneNumber],), # noqa: E501 + 'emails': ([Email],), # noqa: E501 + 'custom_fields': ([CustomField],), # noqa: E501 + 'social_links': ([ApplicantSocialLinks],), # noqa: E501 + 'tax_code': (str, none_type,), # noqa: E501 + 'tax_id': (str, none_type,), # noqa: E501 + 'dietary_preference': (str, none_type,), # noqa: E501 + 'food_allergies': ([str], none_type,), # noqa: E501 + 'tags': ([str],), # noqa: E501 + 'row_version': (str, none_type,), # noqa: E501 + 'deleted': (bool, none_type,), # noqa: E501 + 'updated_by': (str, none_type,), # noqa: E501 + 'created_by': (str, none_type,), # noqa: E501 + 'updated_at': (datetime,), # noqa: E501 + 'created_at': (datetime,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'first_name': 'first_name', # noqa: E501 + 'last_name': 'last_name', # noqa: E501 + 'middle_name': 'middle_name', # noqa: E501 + 'display_name': 'display_name', # noqa: E501 + 'preferred_name': 'preferred_name', # noqa: E501 + 'initials': 'initials', # noqa: E501 + 'salutation': 'salutation', # noqa: E501 + 'title': 'title', # noqa: E501 + 'marital_status': 'marital_status', # noqa: E501 + 'partner': 'partner', # noqa: E501 + 'division': 'division', # noqa: E501 + 'division_id': 'division_id', # noqa: E501 + 'department': 'department', # noqa: E501 + 'department_id': 'department_id', # noqa: E501 + 'team': 'team', # noqa: E501 + 'company_id': 'company_id', # noqa: E501 + 'company_name': 'company_name', # noqa: E501 + 'employment_start_date': 'employment_start_date', # noqa: E501 + 'employment_end_date': 'employment_end_date', # noqa: E501 + 'leaving_reason': 'leaving_reason', # noqa: E501 + 'employee_number': 'employee_number', # noqa: E501 + 'employment_status': 'employment_status', # noqa: E501 + 'employment_role': 'employment_role', # noqa: E501 + 'manager': 'manager', # noqa: E501 + 'direct_reports': 'direct_reports', # noqa: E501 + 'social_security_number': 'social_security_number', # noqa: E501 + 'birthday': 'birthday', # noqa: E501 + 'deceased_on': 'deceased_on', # noqa: E501 + 'country_of_birth': 'country_of_birth', # noqa: E501 + 'description': 'description', # noqa: E501 + 'gender': 'gender', # noqa: E501 + 'pronouns': 'pronouns', # noqa: E501 + 'preferred_language': 'preferred_language', # noqa: E501 + 'languages': 'languages', # noqa: E501 + 'nationalities': 'nationalities', # noqa: E501 + 'photo_url': 'photo_url', # noqa: E501 + 'timezone': 'timezone', # noqa: E501 + 'source': 'source', # noqa: E501 + 'source_id': 'source_id', # noqa: E501 + 'record_url': 'record_url', # noqa: E501 + 'jobs': 'jobs', # noqa: E501 + 'compensations': 'compensations', # noqa: E501 + 'works_remote': 'works_remote', # noqa: E501 + 'addresses': 'addresses', # noqa: E501 + 'phone_numbers': 'phone_numbers', # noqa: E501 + 'emails': 'emails', # noqa: E501 + 'custom_fields': 'custom_fields', # noqa: E501 + 'social_links': 'social_links', # noqa: E501 + 'tax_code': 'tax_code', # noqa: E501 + 'tax_id': 'tax_id', # noqa: E501 + 'dietary_preference': 'dietary_preference', # noqa: E501 + 'food_allergies': 'food_allergies', # noqa: E501 + 'tags': 'tags', # noqa: E501 + 'row_version': 'row_version', # noqa: E501 + 'deleted': 'deleted', # noqa: E501 + 'updated_by': 'updated_by', # noqa: E501 + 'created_by': 'created_by', # noqa: E501 + 'updated_at': 'updated_at', # noqa: E501 + 'created_at': 'created_at', # noqa: E501 + } + + read_only_vars = { + 'id', # noqa: E501 + 'updated_by', # noqa: E501 + 'created_by', # noqa: E501 + 'updated_at', # noqa: E501 + 'created_at', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 + """Employee - a model defined in OpenAPI + + Args: + id (str): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + first_name (str, none_type): [optional] # noqa: E501 + last_name (str, none_type): [optional] # noqa: E501 + middle_name (str, none_type): [optional] # noqa: E501 + display_name (str, none_type): [optional] # noqa: E501 + preferred_name (str, none_type): [optional] # noqa: E501 + initials (str, none_type): [optional] # noqa: E501 + salutation (str, none_type): [optional] # noqa: E501 + title (str, none_type): [optional] # noqa: E501 + marital_status (str, none_type): [optional] # noqa: E501 + partner (EmployeePartner): [optional] # noqa: E501 + division (str, none_type): The division the user is currently in.. [optional] # noqa: E501 + division_id (str, none_type): Unique identifier of the division this employee belongs to.. [optional] # noqa: E501 + department (str, none_type): The department the user is currently in.. [optional] # noqa: E501 + department_id (str, none_type): Unique identifier of the department ID this employee belongs to.. [optional] # noqa: E501 + team (EmployeeTeam): [optional] # noqa: E501 + company_id (str, none_type): [optional] # noqa: E501 + company_name (str, none_type): [optional] # noqa: E501 + employment_start_date (str, none_type): A Start Date is the date that the employee started working at the company. [optional] # noqa: E501 + employment_end_date (str, none_type): A Start Date is the date that the employee ended working at the company. [optional] # noqa: E501 + leaving_reason (str, none_type): The reason because the employment ended. [optional] # noqa: E501 + employee_number (str, none_type): An Employee Number, Employee ID or Employee Code, is a unique number that has been assigned to each individual staff member within a company.. [optional] # noqa: E501 + employment_status (str, none_type): [optional] # noqa: E501 + employment_role (EmployeeEmploymentRole): [optional] # noqa: E501 + manager (EmployeeManager): [optional] # noqa: E501 + direct_reports ([str], none_type): [optional] # noqa: E501 + social_security_number (str, none_type): [optional] # noqa: E501 + birthday (date, none_type): [optional] # noqa: E501 + deceased_on (date, none_type): [optional] # noqa: E501 + country_of_birth (str, none_type): country code according to ISO 3166-1 alpha-2.. [optional] # noqa: E501 + description (str, none_type): [optional] # noqa: E501 + gender (Gender): [optional] # noqa: E501 + pronouns (str, none_type): [optional] # noqa: E501 + preferred_language (str, none_type): language code according to ISO 639-1. For the United States - EN. [optional] # noqa: E501 + languages ([str, none_type]): [optional] # noqa: E501 + nationalities ([str, none_type]): [optional] # noqa: E501 + photo_url (str, none_type): [optional] # noqa: E501 + timezone (str, none_type): [optional] # noqa: E501 + source (str, none_type): When the employee is imported as a new hire, this field indicates what system (e.g. the name of the ATS) this employee was imported from.. [optional] # noqa: E501 + source_id (str, none_type): Unique identifier of the employee in the system this employee was imported from (e.g. the ID in the ATS).. [optional] # noqa: E501 + record_url (str, none_type): [optional] # noqa: E501 + jobs ([EmployeeJobs]): [optional] # noqa: E501 + compensations ([EmployeeCompensations]): [optional] # noqa: E501 + works_remote (bool, none_type): Indicates whether the employee works remote. [optional] # noqa: E501 + addresses ([Address]): [optional] # noqa: E501 + phone_numbers ([PhoneNumber]): [optional] # noqa: E501 + emails ([Email]): [optional] # noqa: E501 + custom_fields ([CustomField]): [optional] # noqa: E501 + social_links ([ApplicantSocialLinks]): [optional] # noqa: E501 + tax_code (str, none_type): [optional] # noqa: E501 + tax_id (str, none_type): [optional] # noqa: E501 + dietary_preference (str, none_type): Indicate the employee's dietary preference.. [optional] # noqa: E501 + food_allergies ([str], none_type): Indicate the employee's food allergies.. [optional] # noqa: E501 + tags ([str]): [optional] # noqa: E501 + row_version (str, none_type): [optional] # noqa: E501 + deleted (bool, none_type): [optional] # noqa: E501 + updated_by (str, none_type): [optional] # noqa: E501 + created_by (str, none_type): [optional] # noqa: E501 + updated_at (datetime): [optional] # noqa: E501 + created_at (datetime): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.id = id + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """Employee - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + first_name (str, none_type): [optional] # noqa: E501 + last_name (str, none_type): [optional] # noqa: E501 + middle_name (str, none_type): [optional] # noqa: E501 + display_name (str, none_type): [optional] # noqa: E501 + preferred_name (str, none_type): [optional] # noqa: E501 + initials (str, none_type): [optional] # noqa: E501 + salutation (str, none_type): [optional] # noqa: E501 + title (str, none_type): [optional] # noqa: E501 + marital_status (str, none_type): [optional] # noqa: E501 + partner (EmployeePartner): [optional] # noqa: E501 + division (str, none_type): The division the user is currently in.. [optional] # noqa: E501 + division_id (str, none_type): Unique identifier of the division this employee belongs to.. [optional] # noqa: E501 + department (str, none_type): The department the user is currently in.. [optional] # noqa: E501 + department_id (str, none_type): Unique identifier of the department ID this employee belongs to.. [optional] # noqa: E501 + team (EmployeeTeam): [optional] # noqa: E501 + company_id (str, none_type): [optional] # noqa: E501 + company_name (str, none_type): [optional] # noqa: E501 + employment_start_date (str, none_type): A Start Date is the date that the employee started working at the company. [optional] # noqa: E501 + employment_end_date (str, none_type): A Start Date is the date that the employee ended working at the company. [optional] # noqa: E501 + leaving_reason (str, none_type): The reason because the employment ended. [optional] # noqa: E501 + employee_number (str, none_type): An Employee Number, Employee ID or Employee Code, is a unique number that has been assigned to each individual staff member within a company.. [optional] # noqa: E501 + employment_status (str, none_type): [optional] # noqa: E501 + employment_role (EmployeeEmploymentRole): [optional] # noqa: E501 + manager (EmployeeManager): [optional] # noqa: E501 + direct_reports ([str], none_type): [optional] # noqa: E501 + social_security_number (str, none_type): [optional] # noqa: E501 + birthday (date, none_type): [optional] # noqa: E501 + deceased_on (date, none_type): [optional] # noqa: E501 + country_of_birth (str, none_type): country code according to ISO 3166-1 alpha-2.. [optional] # noqa: E501 + description (str, none_type): [optional] # noqa: E501 + gender (Gender): [optional] # noqa: E501 + pronouns (str, none_type): [optional] # noqa: E501 + preferred_language (str, none_type): language code according to ISO 639-1. For the United States - EN. [optional] # noqa: E501 + languages ([str, none_type]): [optional] # noqa: E501 + nationalities ([str, none_type]): [optional] # noqa: E501 + photo_url (str, none_type): [optional] # noqa: E501 + timezone (str, none_type): [optional] # noqa: E501 + source (str, none_type): When the employee is imported as a new hire, this field indicates what system (e.g. the name of the ATS) this employee was imported from.. [optional] # noqa: E501 + source_id (str, none_type): Unique identifier of the employee in the system this employee was imported from (e.g. the ID in the ATS).. [optional] # noqa: E501 + record_url (str, none_type): [optional] # noqa: E501 + jobs ([EmployeeJobs]): [optional] # noqa: E501 + compensations ([EmployeeCompensations]): [optional] # noqa: E501 + works_remote (bool, none_type): Indicates whether the employee works remote. [optional] # noqa: E501 + addresses ([Address]): [optional] # noqa: E501 + phone_numbers ([PhoneNumber]): [optional] # noqa: E501 + emails ([Email]): [optional] # noqa: E501 + custom_fields ([CustomField]): [optional] # noqa: E501 + social_links ([ApplicantSocialLinks]): [optional] # noqa: E501 + tax_code (str, none_type): [optional] # noqa: E501 + tax_id (str, none_type): [optional] # noqa: E501 + dietary_preference (str, none_type): Indicate the employee's dietary preference.. [optional] # noqa: E501 + food_allergies ([str], none_type): Indicate the employee's food allergies.. [optional] # noqa: E501 + tags ([str]): [optional] # noqa: E501 + row_version (str, none_type): [optional] # noqa: E501 + deleted (bool, none_type): [optional] # noqa: E501 + updated_by (str, none_type): [optional] # noqa: E501 + created_by (str, none_type): [optional] # noqa: E501 + updated_at (datetime): [optional] # noqa: E501 + created_at (datetime): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/employee_compensations.py b/src/apideck/model/employee_compensations.py new file mode 100644 index 0000000000..368abe8e44 --- /dev/null +++ b/src/apideck/model/employee_compensations.py @@ -0,0 +1,295 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.currency import Currency + from apideck.model.payment_unit import PaymentUnit + globals()['Currency'] = Currency + globals()['PaymentUnit'] = PaymentUnit + + +class EmployeeCompensations(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('flsa_status',): { + 'EXEMPT': "exempt", + 'SALARIED-NONEXEMPT': "salaried-nonexempt", + 'NONEXEMPT': "nonexempt", + 'OWNER': "owner", + }, + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'id': (str,), # noqa: E501 + 'job_id': (str,), # noqa: E501 + 'rate': (float,), # noqa: E501 + 'payment_unit': (PaymentUnit,), # noqa: E501 + 'currency': (Currency,), # noqa: E501 + 'flsa_status': (str,), # noqa: E501 + 'effective_date': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'job_id': 'job_id', # noqa: E501 + 'rate': 'rate', # noqa: E501 + 'payment_unit': 'payment_unit', # noqa: E501 + 'currency': 'currency', # noqa: E501 + 'flsa_status': 'flsa_status', # noqa: E501 + 'effective_date': 'effective_date', # noqa: E501 + } + + read_only_vars = { + 'id', # noqa: E501 + 'job_id', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """EmployeeCompensations - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + job_id (str): The ID of the job to which the compensation belongs.. [optional] # noqa: E501 + rate (float): The amount paid per payment unit.. [optional] # noqa: E501 + payment_unit (PaymentUnit): [optional] # noqa: E501 + currency (Currency): [optional] # noqa: E501 + flsa_status (str): The FLSA status for this compensation.. [optional] # noqa: E501 + effective_date (str): The effective date for this compensation.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """EmployeeCompensations - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + job_id (str): The ID of the job to which the compensation belongs.. [optional] # noqa: E501 + rate (float): The amount paid per payment unit.. [optional] # noqa: E501 + payment_unit (PaymentUnit): [optional] # noqa: E501 + currency (Currency): [optional] # noqa: E501 + flsa_status (str): The FLSA status for this compensation.. [optional] # noqa: E501 + effective_date (str): The effective date for this compensation.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/employee_employment_role.py b/src/apideck/model/employee_employment_role.py new file mode 100644 index 0000000000..81dadef166 --- /dev/null +++ b/src/apideck/model/employee_employment_role.py @@ -0,0 +1,274 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class EmployeeEmploymentRole(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('type',): { + 'None': None, + 'CONTRACTOR': "contractor", + 'EMPLOYEE': "employee", + 'FREELANCE': "freelance", + 'TEMP': "temp", + 'INTERSHIP': "intership", + 'OTHER': "other", + }, + ('sub_type',): { + 'None': None, + 'FULL_TIME': "full_time", + 'PART_TIME': "part_time", + 'HOURLY': "hourly", + }, + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'type': (str, none_type,), # noqa: E501 + 'sub_type': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'type': 'type', # noqa: E501 + 'sub_type': 'sub_type', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """EmployeeEmploymentRole - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + type (str, none_type): [optional] # noqa: E501 + sub_type (str, none_type): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """EmployeeEmploymentRole - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + type (str, none_type): [optional] # noqa: E501 + sub_type (str, none_type): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/employee_jobs.py b/src/apideck/model/employee_jobs.py new file mode 100644 index 0000000000..9cfde337d3 --- /dev/null +++ b/src/apideck/model/employee_jobs.py @@ -0,0 +1,311 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.address import Address + from apideck.model.currency import Currency + from apideck.model.payment_unit import PaymentUnit + globals()['Address'] = Address + globals()['Currency'] = Currency + globals()['PaymentUnit'] = PaymentUnit + + +class EmployeeJobs(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'id': (str,), # noqa: E501 + 'employee_id': (str,), # noqa: E501 + 'title': (str, none_type,), # noqa: E501 + 'role': (str, none_type,), # noqa: E501 + 'start_date': (date, none_type,), # noqa: E501 + 'end_date': (date, none_type,), # noqa: E501 + 'compensation_rate': (float,), # noqa: E501 + 'currency': (Currency,), # noqa: E501 + 'payment_unit': (PaymentUnit,), # noqa: E501 + 'hired_at': (date, none_type,), # noqa: E501 + 'is_primary': (bool, none_type,), # noqa: E501 + 'location': (Address,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'employee_id': 'employee_id', # noqa: E501 + 'title': 'title', # noqa: E501 + 'role': 'role', # noqa: E501 + 'start_date': 'start_date', # noqa: E501 + 'end_date': 'end_date', # noqa: E501 + 'compensation_rate': 'compensation_rate', # noqa: E501 + 'currency': 'currency', # noqa: E501 + 'payment_unit': 'payment_unit', # noqa: E501 + 'hired_at': 'hired_at', # noqa: E501 + 'is_primary': 'is_primary', # noqa: E501 + 'location': 'location', # noqa: E501 + } + + read_only_vars = { + 'id', # noqa: E501 + 'employee_id', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """EmployeeJobs - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + employee_id (str): [optional] # noqa: E501 + title (str, none_type): [optional] # noqa: E501 + role (str, none_type): [optional] # noqa: E501 + start_date (date, none_type): [optional] # noqa: E501 + end_date (date, none_type): [optional] # noqa: E501 + compensation_rate (float): [optional] # noqa: E501 + currency (Currency): [optional] # noqa: E501 + payment_unit (PaymentUnit): [optional] # noqa: E501 + hired_at (date, none_type): [optional] # noqa: E501 + is_primary (bool, none_type): Indicates whether this the employee's primary job. [optional] # noqa: E501 + location (Address): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """EmployeeJobs - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + employee_id (str): [optional] # noqa: E501 + title (str, none_type): [optional] # noqa: E501 + role (str, none_type): [optional] # noqa: E501 + start_date (date, none_type): [optional] # noqa: E501 + end_date (date, none_type): [optional] # noqa: E501 + compensation_rate (float): [optional] # noqa: E501 + currency (Currency): [optional] # noqa: E501 + payment_unit (PaymentUnit): [optional] # noqa: E501 + hired_at (date, none_type): [optional] # noqa: E501 + is_primary (bool, none_type): Indicates whether this the employee's primary job. [optional] # noqa: E501 + location (Address): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/employee_manager.py b/src/apideck/model/employee_manager.py new file mode 100644 index 0000000000..82bab02ca6 --- /dev/null +++ b/src/apideck/model/employee_manager.py @@ -0,0 +1,272 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class EmployeeManager(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'id': (str,), # noqa: E501 + 'name': (str, none_type,), # noqa: E501 + 'first_name': (str, none_type,), # noqa: E501 + 'last_name': (str, none_type,), # noqa: E501 + 'email': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'name': 'name', # noqa: E501 + 'first_name': 'first_name', # noqa: E501 + 'last_name': 'last_name', # noqa: E501 + 'email': 'email', # noqa: E501 + } + + read_only_vars = { + 'id', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """EmployeeManager - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + name (str, none_type): [optional] # noqa: E501 + first_name (str, none_type): [optional] # noqa: E501 + last_name (str, none_type): [optional] # noqa: E501 + email (str, none_type): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """EmployeeManager - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + name (str, none_type): [optional] # noqa: E501 + first_name (str, none_type): [optional] # noqa: E501 + last_name (str, none_type): [optional] # noqa: E501 + email (str, none_type): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/employee_partner.py b/src/apideck/model/employee_partner.py new file mode 100644 index 0000000000..2f3ae07f84 --- /dev/null +++ b/src/apideck/model/employee_partner.py @@ -0,0 +1,290 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.gender import Gender + globals()['Gender'] = Gender + + +class EmployeePartner(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'id': (str,), # noqa: E501 + 'first_name': (str, none_type,), # noqa: E501 + 'last_name': (str, none_type,), # noqa: E501 + 'middle_name': (str, none_type,), # noqa: E501 + 'gender': (Gender,), # noqa: E501 + 'initials': (str, none_type,), # noqa: E501 + 'birthday': (date, none_type,), # noqa: E501 + 'deceased_on': (date, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'first_name': 'first_name', # noqa: E501 + 'last_name': 'last_name', # noqa: E501 + 'middle_name': 'middle_name', # noqa: E501 + 'gender': 'gender', # noqa: E501 + 'initials': 'initials', # noqa: E501 + 'birthday': 'birthday', # noqa: E501 + 'deceased_on': 'deceased_on', # noqa: E501 + } + + read_only_vars = { + 'id', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """EmployeePartner - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + first_name (str, none_type): [optional] # noqa: E501 + last_name (str, none_type): [optional] # noqa: E501 + middle_name (str, none_type): [optional] # noqa: E501 + gender (Gender): [optional] # noqa: E501 + initials (str, none_type): [optional] # noqa: E501 + birthday (date, none_type): [optional] # noqa: E501 + deceased_on (date, none_type): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """EmployeePartner - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + first_name (str, none_type): [optional] # noqa: E501 + last_name (str, none_type): [optional] # noqa: E501 + middle_name (str, none_type): [optional] # noqa: E501 + gender (Gender): [optional] # noqa: E501 + initials (str, none_type): [optional] # noqa: E501 + birthday (date, none_type): [optional] # noqa: E501 + deceased_on (date, none_type): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/employee_payroll.py b/src/apideck/model/employee_payroll.py new file mode 100644 index 0000000000..b88a47e1f3 --- /dev/null +++ b/src/apideck/model/employee_payroll.py @@ -0,0 +1,267 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.employee import Employee + from apideck.model.payroll import Payroll + globals()['Employee'] = Employee + globals()['Payroll'] = Payroll + + +class EmployeePayroll(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'employee': (Employee,), # noqa: E501 + 'payroll': (Payroll,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'employee': 'employee', # noqa: E501 + 'payroll': 'payroll', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """EmployeePayroll - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + employee (Employee): [optional] # noqa: E501 + payroll (Payroll): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """EmployeePayroll - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + employee (Employee): [optional] # noqa: E501 + payroll (Payroll): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/employee_payrolls.py b/src/apideck/model/employee_payrolls.py new file mode 100644 index 0000000000..98575f44f1 --- /dev/null +++ b/src/apideck/model/employee_payrolls.py @@ -0,0 +1,267 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.employee import Employee + from apideck.model.payroll import Payroll + globals()['Employee'] = Employee + globals()['Payroll'] = Payroll + + +class EmployeePayrolls(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'employee': (Employee,), # noqa: E501 + 'payrolls': ([Payroll],), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'employee': 'employee', # noqa: E501 + 'payrolls': 'payrolls', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """EmployeePayrolls - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + employee (Employee): [optional] # noqa: E501 + payrolls ([Payroll]): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """EmployeePayrolls - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + employee (Employee): [optional] # noqa: E501 + payrolls ([Payroll]): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/employee_schedules.py b/src/apideck/model/employee_schedules.py new file mode 100644 index 0000000000..19682e18d0 --- /dev/null +++ b/src/apideck/model/employee_schedules.py @@ -0,0 +1,267 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.employee import Employee + from apideck.model.schedule import Schedule + globals()['Employee'] = Employee + globals()['Schedule'] = Schedule + + +class EmployeeSchedules(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'employee': (Employee,), # noqa: E501 + 'schedules': ([Schedule],), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'employee': 'employee', # noqa: E501 + 'schedules': 'schedules', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """EmployeeSchedules - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + employee (Employee): [optional] # noqa: E501 + schedules ([Schedule]): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """EmployeeSchedules - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + employee (Employee): [optional] # noqa: E501 + schedules ([Schedule]): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/employee_team.py b/src/apideck/model/employee_team.py new file mode 100644 index 0000000000..04eae5915a --- /dev/null +++ b/src/apideck/model/employee_team.py @@ -0,0 +1,259 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class EmployeeTeam(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = True + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'id': (str, none_type,), # noqa: E501 + 'name': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'name': 'name', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """EmployeeTeam - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str, none_type): [optional] # noqa: E501 + name (str, none_type): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """EmployeeTeam - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str, none_type): [optional] # noqa: E501 + name (str, none_type): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/employees_filter.py b/src/apideck/model/employees_filter.py new file mode 100644 index 0000000000..d9906bba48 --- /dev/null +++ b/src/apideck/model/employees_filter.py @@ -0,0 +1,283 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class EmployeesFilter(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('employment_status',): { + 'ACTIVE': "active", + 'INACTIVE': "inactive", + 'TERMINATED': "terminated", + 'OTHER': "other", + }, + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'company_id': (str,), # noqa: E501 + 'email': (str,), # noqa: E501 + 'first_name': (str,), # noqa: E501 + 'title': (str,), # noqa: E501 + 'last_name': (str,), # noqa: E501 + 'manager_id': (str,), # noqa: E501 + 'employment_status': (str,), # noqa: E501 + 'employee_number': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'company_id': 'company_id', # noqa: E501 + 'email': 'email', # noqa: E501 + 'first_name': 'first_name', # noqa: E501 + 'title': 'title', # noqa: E501 + 'last_name': 'last_name', # noqa: E501 + 'manager_id': 'manager_id', # noqa: E501 + 'employment_status': 'employment_status', # noqa: E501 + 'employee_number': 'employee_number', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """EmployeesFilter - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + company_id (str): Company ID to filter on. [optional] # noqa: E501 + email (str): Email to filter on. [optional] # noqa: E501 + first_name (str): First Name to filter on. [optional] # noqa: E501 + title (str): Job title to filter on. [optional] # noqa: E501 + last_name (str): Last Name to filter on. [optional] # noqa: E501 + manager_id (str): Manager id to filter on. [optional] # noqa: E501 + employment_status (str): Employment status to filter on. [optional] # noqa: E501 + employee_number (str): Employee number to filter on. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """EmployeesFilter - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + company_id (str): Company ID to filter on. [optional] # noqa: E501 + email (str): Email to filter on. [optional] # noqa: E501 + first_name (str): First Name to filter on. [optional] # noqa: E501 + title (str): Job title to filter on. [optional] # noqa: E501 + last_name (str): Last Name to filter on. [optional] # noqa: E501 + manager_id (str): Manager id to filter on. [optional] # noqa: E501 + employment_status (str): Employment status to filter on. [optional] # noqa: E501 + employee_number (str): Employee number to filter on. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/error.py b/src/apideck/model/error.py new file mode 100644 index 0000000000..e7a9c40983 --- /dev/null +++ b/src/apideck/model/error.py @@ -0,0 +1,261 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class Error(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'code': (str,), # noqa: E501 + 'message': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'code': 'code', # noqa: E501 + 'message': 'message', # noqa: E501 + } + + read_only_vars = { + 'code', # noqa: E501 + 'message', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """Error - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + code (str): The error_code provides more information about the failure. If the message was successful, this value is null. [optional] # noqa: E501 + message (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """Error - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + code (str): The error_code provides more information about the failure. If the message was successful, this value is null. [optional] # noqa: E501 + message (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/execute_base_url.py b/src/apideck/model/execute_base_url.py new file mode 100644 index 0000000000..8bf69f8dc6 --- /dev/null +++ b/src/apideck/model/execute_base_url.py @@ -0,0 +1,283 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class ExecuteBaseUrl(ModelSimple): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + ('value',): { + 'regex': { + 'pattern': r'', # noqa: E501 + }, + }, + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'value': (str,), + } + + @cached_property + def discriminator(): + return None + + + attribute_map = {} + + read_only_vars = set() + + _composed_schemas = None + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): + """ExecuteBaseUrl - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] (str): The Unify Base URL events from connectors will be sent to after service id is appended.. # noqa: E501 + + Keyword Args: + value (str): The Unify Base URL events from connectors will be sent to after service id is appended.. # noqa: E501 + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + self.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): + """ExecuteBaseUrl - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] (str): The Unify Base URL events from connectors will be sent to after service id is appended.. # noqa: E501 + + Keyword Args: + value (str): The Unify Base URL events from connectors will be sent to after service id is appended.. # noqa: E501 + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + self.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + return self diff --git a/src/apideck/model/execute_webhook_event_request.py b/src/apideck/model/execute_webhook_event_request.py new file mode 100644 index 0000000000..51900c5c1c --- /dev/null +++ b/src/apideck/model/execute_webhook_event_request.py @@ -0,0 +1,251 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class ExecuteWebhookEventRequest(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ExecuteWebhookEventRequest - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """ExecuteWebhookEventRequest - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/execute_webhook_events_request.py b/src/apideck/model/execute_webhook_events_request.py new file mode 100644 index 0000000000..577a820946 --- /dev/null +++ b/src/apideck/model/execute_webhook_events_request.py @@ -0,0 +1,278 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class ExecuteWebhookEventsRequest(ModelSimple): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'value': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + } + + @cached_property + def discriminator(): + return None + + + attribute_map = {} + + read_only_vars = set() + + _composed_schemas = None + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): + """ExecuteWebhookEventsRequest - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]): # noqa: E501 + + Keyword Args: + value ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]): # noqa: E501 + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + self.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): + """ExecuteWebhookEventsRequest - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]): # noqa: E501 + + Keyword Args: + value ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]): # noqa: E501 + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + self.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + return self diff --git a/src/apideck/model/execute_webhook_response.py b/src/apideck/model/execute_webhook_response.py new file mode 100644 index 0000000000..640b73640b --- /dev/null +++ b/src/apideck/model/execute_webhook_response.py @@ -0,0 +1,275 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class ExecuteWebhookResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'request_id': (str,), # noqa: E501 + 'timestamp': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'request_id': 'request_id', # noqa: E501 + 'timestamp': 'timestamp', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, *args, **kwargs): # noqa: E501 + """ExecuteWebhookResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + request_id (str): UUID of the request received. [optional] # noqa: E501 + timestamp (str): ISO Datetime webhook event was received. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, *args, **kwargs): # noqa: E501 + """ExecuteWebhookResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + request_id (str): UUID of the request received. [optional] # noqa: E501 + timestamp (str): ISO Datetime webhook event was received. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/file_storage_event_type.py b/src/apideck/model/file_storage_event_type.py new file mode 100644 index 0000000000..b1a443ccf7 --- /dev/null +++ b/src/apideck/model/file_storage_event_type.py @@ -0,0 +1,284 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class FileStorageEventType(ModelSimple): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('value',): { + '*': "*", + 'FILE-STORAGE.FILE.CREATED': "file-storage.file.created", + 'FILE-STORAGE.FILE.UPDATED': "file-storage.file.updated", + 'FILE-STORAGE.FILE.DELETED': "file-storage.file.deleted", + }, + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'value': (str,), + } + + @cached_property + def discriminator(): + return None + + + attribute_map = {} + + read_only_vars = set() + + _composed_schemas = None + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): + """FileStorageEventType - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] (str):, must be one of ["*", "file-storage.file.created", "file-storage.file.updated", "file-storage.file.deleted", ] # noqa: E501 + + Keyword Args: + value (str):, must be one of ["*", "file-storage.file.created", "file-storage.file.updated", "file-storage.file.deleted", ] # noqa: E501 + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + self.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): + """FileStorageEventType - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] (str):, must be one of ["*", "file-storage.file.created", "file-storage.file.updated", "file-storage.file.deleted", ] # noqa: E501 + + Keyword Args: + value (str):, must be one of ["*", "file-storage.file.created", "file-storage.file.updated", "file-storage.file.deleted", ] # noqa: E501 + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + self.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + return self diff --git a/src/apideck/model/file_type.py b/src/apideck/model/file_type.py new file mode 100644 index 0000000000..b6dc90fa58 --- /dev/null +++ b/src/apideck/model/file_type.py @@ -0,0 +1,283 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class FileType(ModelSimple): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('value',): { + 'FILE': "file", + 'FOLDER': "folder", + 'URL': "url", + }, + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'value': (str,), + } + + @cached_property + def discriminator(): + return None + + + attribute_map = {} + + read_only_vars = set() + + _composed_schemas = None + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): + """FileType - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] (str): The type of resource. Could be file, folder or url., must be one of ["file", "folder", "url", ] # noqa: E501 + + Keyword Args: + value (str): The type of resource. Could be file, folder or url., must be one of ["file", "folder", "url", ] # noqa: E501 + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + self.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): + """FileType - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] (str): The type of resource. Could be file, folder or url., must be one of ["file", "folder", "url", ] # noqa: E501 + + Keyword Args: + value (str): The type of resource. Could be file, folder or url., must be one of ["file", "folder", "url", ] # noqa: E501 + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + self.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + return self diff --git a/src/apideck/model/files_filter.py b/src/apideck/model/files_filter.py new file mode 100644 index 0000000000..9de5647be5 --- /dev/null +++ b/src/apideck/model/files_filter.py @@ -0,0 +1,257 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class FilesFilter(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'drive_id': (str,), # noqa: E501 + 'folder_id': (str,), # noqa: E501 + 'shared': (bool,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'drive_id': 'drive_id', # noqa: E501 + 'folder_id': 'folder_id', # noqa: E501 + 'shared': 'shared', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """FilesFilter - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + drive_id (str): ID of the drive to filter on. [optional] # noqa: E501 + folder_id (str): ID of the folder to filter on. The root folder has an alias \"root\". [optional] # noqa: E501 + shared (bool): Only return files and folders that are shared. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """FilesFilter - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + drive_id (str): ID of the drive to filter on. [optional] # noqa: E501 + folder_id (str): ID of the folder to filter on. The root folder has an alias \"root\". [optional] # noqa: E501 + shared (bool): Only return files and folders that are shared. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/files_search.py b/src/apideck/model/files_search.py new file mode 100644 index 0000000000..508d20225b --- /dev/null +++ b/src/apideck/model/files_search.py @@ -0,0 +1,259 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class FilesSearch(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'query': (str,), # noqa: E501 + 'drive_id': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'query': 'query', # noqa: E501 + 'drive_id': 'drive_id', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, query, *args, **kwargs): # noqa: E501 + """FilesSearch - a model defined in OpenAPI + + Args: + query (str): The query to search for. May match across multiple fields. + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + drive_id (str): ID of the drive to filter on. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.query = query + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, query, *args, **kwargs): # noqa: E501 + """FilesSearch - a model defined in OpenAPI + + Args: + query (str): The query to search for. May match across multiple fields. + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + drive_id (str): ID of the drive to filter on. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.query = query + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/files_sort.py b/src/apideck/model/files_sort.py new file mode 100644 index 0000000000..6446c0f73c --- /dev/null +++ b/src/apideck/model/files_sort.py @@ -0,0 +1,262 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.sort_direction import SortDirection + globals()['SortDirection'] = SortDirection + + +class FilesSort(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('by',): { + 'UPDATED_AT': "updated_at", + 'NAME': "name", + }, + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'by': (str,), # noqa: E501 + 'direction': (SortDirection,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'by': 'by', # noqa: E501 + 'direction': 'direction', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """FilesSort - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + by (str): The field on which to sort the Files. [optional] # noqa: E501 + direction (SortDirection): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """FilesSort - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + by (str): The field on which to sort the Files. [optional] # noqa: E501 + direction (SortDirection): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/folder.py b/src/apideck/model/folder.py new file mode 100644 index 0000000000..eb9c476d1a --- /dev/null +++ b/src/apideck/model/folder.py @@ -0,0 +1,316 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.linked_folder import LinkedFolder + from apideck.model.owner import Owner + globals()['LinkedFolder'] = LinkedFolder + globals()['Owner'] = Owner + + +class Folder(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'name': (str,), # noqa: E501 + 'parent_folders': ([LinkedFolder],), # noqa: E501 + 'id': (str,), # noqa: E501 + 'description': (str,), # noqa: E501 + 'path': (str,), # noqa: E501 + 'size': (int,), # noqa: E501 + 'owner': (Owner,), # noqa: E501 + 'parent_folders_complete': (bool,), # noqa: E501 + 'updated_by': (str, none_type,), # noqa: E501 + 'created_by': (str, none_type,), # noqa: E501 + 'updated_at': (datetime,), # noqa: E501 + 'created_at': (datetime,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'name': 'name', # noqa: E501 + 'parent_folders': 'parent_folders', # noqa: E501 + 'id': 'id', # noqa: E501 + 'description': 'description', # noqa: E501 + 'path': 'path', # noqa: E501 + 'size': 'size', # noqa: E501 + 'owner': 'owner', # noqa: E501 + 'parent_folders_complete': 'parent_folders_complete', # noqa: E501 + 'updated_by': 'updated_by', # noqa: E501 + 'created_by': 'created_by', # noqa: E501 + 'updated_at': 'updated_at', # noqa: E501 + 'created_at': 'created_at', # noqa: E501 + } + + read_only_vars = { + 'id', # noqa: E501 + 'path', # noqa: E501 + 'size', # noqa: E501 + 'parent_folders_complete', # noqa: E501 + 'updated_by', # noqa: E501 + 'created_by', # noqa: E501 + 'updated_at', # noqa: E501 + 'created_at', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, name, parent_folders, *args, **kwargs): # noqa: E501 + """Folder - a model defined in OpenAPI + + Args: + name (str): The name of the folder + parent_folders ([LinkedFolder]): The parent folders of the file, starting from the root + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + description (str): Optional description of the folder. [optional] # noqa: E501 + path (str): The full path of the folder (includes the folder name). [optional] # noqa: E501 + size (int): The size of the folder in bytes. [optional] # noqa: E501 + owner (Owner): [optional] # noqa: E501 + parent_folders_complete (bool): Whether the list of parent folder is complete. Some connectors only return the direct parent of a folder. [optional] # noqa: E501 + updated_by (str, none_type): [optional] # noqa: E501 + created_by (str, none_type): [optional] # noqa: E501 + updated_at (datetime): [optional] # noqa: E501 + created_at (datetime): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.name = name + self.parent_folders = parent_folders + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, name, parent_folders, *args, **kwargs): # noqa: E501 + """Folder - a model defined in OpenAPI + + Args: + name (str): The name of the folder + parent_folders ([LinkedFolder]): The parent folders of the file, starting from the root + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + description (str): Optional description of the folder. [optional] # noqa: E501 + path (str): The full path of the folder (includes the folder name). [optional] # noqa: E501 + size (int): The size of the folder in bytes. [optional] # noqa: E501 + owner (Owner): [optional] # noqa: E501 + parent_folders_complete (bool): Whether the list of parent folder is complete. Some connectors only return the direct parent of a folder. [optional] # noqa: E501 + updated_by (str, none_type): [optional] # noqa: E501 + created_by (str, none_type): [optional] # noqa: E501 + updated_at (datetime): [optional] # noqa: E501 + created_at (datetime): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.name = name + self.parent_folders = parent_folders + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/form_field.py b/src/apideck/model/form_field.py new file mode 100644 index 0000000000..9adda7bc41 --- /dev/null +++ b/src/apideck/model/form_field.py @@ -0,0 +1,320 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.form_field_option import FormFieldOption + globals()['FormFieldOption'] = FormFieldOption + + +class FormField(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('type',): { + 'TEXT': "text", + 'CHECKBOX': "checkbox", + 'TEL': "tel", + 'EMAIL': "email", + 'URL': "url", + 'TEXTAREA': "textarea", + 'SELECT': "select", + 'FILTERED-SELECT': "filtered-select", + 'MULTI-SELECT': "multi-select", + 'DATETIME': "datetime", + 'DATE': "date", + 'TIME': "time", + 'NUMBER': "number", + }, + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'id': (str,), # noqa: E501 + 'label': (str,), # noqa: E501 + 'placeholder': (str, none_type,), # noqa: E501 + 'description': (str, none_type,), # noqa: E501 + 'type': (str,), # noqa: E501 + 'required': (bool,), # noqa: E501 + 'custom_field': (bool,), # noqa: E501 + 'allow_custom_values': (bool,), # noqa: E501 + 'disabled': (bool, none_type,), # noqa: E501 + 'hidden': (bool, none_type,), # noqa: E501 + 'sensitive': (bool, none_type,), # noqa: E501 + 'options': ([FormFieldOption],), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'label': 'label', # noqa: E501 + 'placeholder': 'placeholder', # noqa: E501 + 'description': 'description', # noqa: E501 + 'type': 'type', # noqa: E501 + 'required': 'required', # noqa: E501 + 'custom_field': 'custom_field', # noqa: E501 + 'allow_custom_values': 'allow_custom_values', # noqa: E501 + 'disabled': 'disabled', # noqa: E501 + 'hidden': 'hidden', # noqa: E501 + 'sensitive': 'sensitive', # noqa: E501 + 'options': 'options', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """FormField - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): The unique identifier of the form field.. [optional] # noqa: E501 + label (str): The label of the field. [optional] # noqa: E501 + placeholder (str, none_type): The placeholder for the form field. [optional] # noqa: E501 + description (str, none_type): The description of the form field. [optional] # noqa: E501 + type (str): [optional] # noqa: E501 + required (bool): Indicates if the form field is required, which means it must be filled in before the form can be submitted. [optional] # noqa: E501 + custom_field (bool): [optional] # noqa: E501 + allow_custom_values (bool): Only applicable to select fields. Allow the user to add a custom value though the option select if the desired value is not in the option select list.. [optional] if omitted the server will use the default value of False # noqa: E501 + disabled (bool, none_type): Indicates if the form field is displayed in a “read-only” mode.. [optional] # noqa: E501 + hidden (bool, none_type): Indicates if the form field is not displayed but the value that is being stored on the connection.. [optional] # noqa: E501 + sensitive (bool, none_type): Indicates if the form field contains sensitive data, which will display the value as a masked input.. [optional] # noqa: E501 + options ([FormFieldOption]): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """FormField - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): The unique identifier of the form field.. [optional] # noqa: E501 + label (str): The label of the field. [optional] # noqa: E501 + placeholder (str, none_type): The placeholder for the form field. [optional] # noqa: E501 + description (str, none_type): The description of the form field. [optional] # noqa: E501 + type (str): [optional] # noqa: E501 + required (bool): Indicates if the form field is required, which means it must be filled in before the form can be submitted. [optional] # noqa: E501 + custom_field (bool): [optional] # noqa: E501 + allow_custom_values (bool): Only applicable to select fields. Allow the user to add a custom value though the option select if the desired value is not in the option select list.. [optional] if omitted the server will use the default value of False # noqa: E501 + disabled (bool, none_type): Indicates if the form field is displayed in a “read-only” mode.. [optional] # noqa: E501 + hidden (bool, none_type): Indicates if the form field is not displayed but the value that is being stored on the connection.. [optional] # noqa: E501 + sensitive (bool, none_type): Indicates if the form field contains sensitive data, which will display the value as a masked input.. [optional] # noqa: E501 + options ([FormFieldOption]): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/form_field_option.py b/src/apideck/model/form_field_option.py new file mode 100644 index 0000000000..08f759fd13 --- /dev/null +++ b/src/apideck/model/form_field_option.py @@ -0,0 +1,326 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.form_field_option_group import FormFieldOptionGroup + from apideck.model.simple_form_field_option import SimpleFormFieldOption + globals()['FormFieldOptionGroup'] = FormFieldOptionGroup + globals()['SimpleFormFieldOption'] = SimpleFormFieldOption + + +class FormFieldOption(ModelComposed): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'label': (str,), # noqa: E501 + 'value': (bool, date, datetime, dict, float, int, list, str, none_type,), # noqa: E501 + 'id': (str,), # noqa: E501 + 'options': ([SimpleFormFieldOption],), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'label': 'label', # noqa: E501 + 'value': 'value', # noqa: E501 + 'id': 'id', # noqa: E501 + 'options': 'options', # noqa: E501 + } + + read_only_vars = { + } + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """FormFieldOption - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + label (str): [optional] # noqa: E501 + value (bool, date, datetime, dict, float, int, list, str, none_type): [optional] # noqa: E501 + id (str): [optional] # noqa: E501 + options ([SimpleFormFieldOption]): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + constant_args = { + '_check_type': _check_type, + '_path_to_item': _path_to_item, + '_spec_property_naming': _spec_property_naming, + '_configuration': _configuration, + '_visited_composed_classes': self._visited_composed_classes, + } + composed_info = validate_get_composed_info( + constant_args, kwargs, self) + self._composed_instances = composed_info[0] + self._var_name_to_model_instances = composed_info[1] + self._additional_properties_model_instances = composed_info[2] + discarded_args = composed_info[3] + + for var_name, var_value in kwargs.items(): + if var_name in discarded_args and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self._additional_properties_model_instances: + # discard variable. + continue + setattr(self, var_name, var_value) + + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + '_composed_instances', + '_var_name_to_model_instances', + '_additional_properties_model_instances', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """FormFieldOption - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + label (str): [optional] # noqa: E501 + value (bool, date, datetime, dict, float, int, list, str, none_type): [optional] # noqa: E501 + id (str): [optional] # noqa: E501 + options ([SimpleFormFieldOption]): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + constant_args = { + '_check_type': _check_type, + '_path_to_item': _path_to_item, + '_spec_property_naming': _spec_property_naming, + '_configuration': _configuration, + '_visited_composed_classes': self._visited_composed_classes, + } + composed_info = validate_get_composed_info( + constant_args, kwargs, self) + self._composed_instances = composed_info[0] + self._var_name_to_model_instances = composed_info[1] + self._additional_properties_model_instances = composed_info[2] + discarded_args = composed_info[3] + + for var_name, var_value in kwargs.items(): + if var_name in discarded_args and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self._additional_properties_model_instances: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") + + @cached_property + def _composed_schemas(): + # we need this here to make our import statements work + # we must store _composed_schemas in here so the code is only run + # when we invoke this method. If we kept this at the class + # level we would get an error because the class level + # code would be run when this module is imported, and these composed + # classes don't exist yet because their module has not finished + # loading + lazy_import() + return { + 'anyOf': [ + FormFieldOptionGroup, + SimpleFormFieldOption, + ], + 'allOf': [ + ], + 'oneOf': [ + ], + } diff --git a/src/apideck/model/form_field_option_group.py b/src/apideck/model/form_field_option_group.py new file mode 100644 index 0000000000..7f11d0afed --- /dev/null +++ b/src/apideck/model/form_field_option_group.py @@ -0,0 +1,269 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.simple_form_field_option import SimpleFormFieldOption + globals()['SimpleFormFieldOption'] = SimpleFormFieldOption + + +class FormFieldOptionGroup(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'id': (str,), # noqa: E501 + 'label': (str,), # noqa: E501 + 'options': ([SimpleFormFieldOption],), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'label': 'label', # noqa: E501 + 'options': 'options', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """FormFieldOptionGroup - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + label (str): [optional] # noqa: E501 + options ([SimpleFormFieldOption]): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """FormFieldOptionGroup - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + label (str): [optional] # noqa: E501 + options ([SimpleFormFieldOption]): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/gender.py b/src/apideck/model/gender.py new file mode 100644 index 0000000000..c1f7153ecd --- /dev/null +++ b/src/apideck/model/gender.py @@ -0,0 +1,286 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class Gender(ModelSimple): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('value',): { + 'None': None, + 'MALE': "male", + 'FEMALE': "female", + 'UNISEX': "unisex", + 'OTHER': "other", + 'NOT_SPECIFIED': "not_specified", + }, + } + + validations = { + } + + additional_properties_type = None + + _nullable = True + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'value': (str,), + } + + @cached_property + def discriminator(): + return None + + + attribute_map = {} + + read_only_vars = set() + + _composed_schemas = None + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): + """Gender - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] (str):, must be one of ["male", "female", "unisex", "other", "not_specified", ] # noqa: E501 + + Keyword Args: + value (str):, must be one of ["male", "female", "unisex", "other", "not_specified", ] # noqa: E501 + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + self.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): + """Gender - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] (str):, must be one of ["male", "female", "unisex", "other", "not_specified", ] # noqa: E501 + + Keyword Args: + value (str):, must be one of ["male", "female", "unisex", "other", "not_specified", ] # noqa: E501 + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + self.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + return self diff --git a/src/apideck/model/get_activities_response.py b/src/apideck/model/get_activities_response.py new file mode 100644 index 0000000000..54f6b3eeb4 --- /dev/null +++ b/src/apideck/model/get_activities_response.py @@ -0,0 +1,309 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.activity import Activity + from apideck.model.links import Links + from apideck.model.meta import Meta + globals()['Activity'] = Activity + globals()['Links'] = Links + globals()['Meta'] = Meta + + +class GetActivitiesResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': ([Activity],), # noqa: E501 + 'meta': (Meta,), # noqa: E501 + 'links': (Links,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + 'meta': 'meta', # noqa: E501 + 'links': 'links', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetActivitiesResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data ([Activity]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (Meta): [optional] # noqa: E501 + links (Links): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetActivitiesResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data ([Activity]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (Meta): [optional] # noqa: E501 + links (Links): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/get_activity_response.py b/src/apideck/model/get_activity_response.py new file mode 100644 index 0000000000..2241e916fa --- /dev/null +++ b/src/apideck/model/get_activity_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.activity import Activity + globals()['Activity'] = Activity + + +class GetActivityResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (Activity,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetActivityResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (Activity): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetActivityResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (Activity): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/get_api_resource_coverage_response.py b/src/apideck/model/get_api_resource_coverage_response.py new file mode 100644 index 0000000000..47e9d6f4f0 --- /dev/null +++ b/src/apideck/model/get_api_resource_coverage_response.py @@ -0,0 +1,291 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.api_resource_coverage import ApiResourceCoverage + from apideck.model.links import Links + from apideck.model.meta import Meta + globals()['ApiResourceCoverage'] = ApiResourceCoverage + globals()['Links'] = Links + globals()['Meta'] = Meta + + +class GetApiResourceCoverageResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'data': (ApiResourceCoverage,), # noqa: E501 + 'meta': (Meta,), # noqa: E501 + 'links': (Links,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'data': 'data', # noqa: E501 + 'meta': 'meta', # noqa: E501 + 'links': 'links', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, data, *args, **kwargs): # noqa: E501 + """GetApiResourceCoverageResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + data (ApiResourceCoverage): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (Meta): [optional] # noqa: E501 + links (Links): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, data, *args, **kwargs): # noqa: E501 + """GetApiResourceCoverageResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + data (ApiResourceCoverage): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (Meta): [optional] # noqa: E501 + links (Links): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/get_api_resource_response.py b/src/apideck/model/get_api_resource_response.py new file mode 100644 index 0000000000..8776a8fcfd --- /dev/null +++ b/src/apideck/model/get_api_resource_response.py @@ -0,0 +1,291 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.api_resource import ApiResource + from apideck.model.links import Links + from apideck.model.meta import Meta + globals()['ApiResource'] = ApiResource + globals()['Links'] = Links + globals()['Meta'] = Meta + + +class GetApiResourceResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'data': (ApiResource,), # noqa: E501 + 'meta': (Meta,), # noqa: E501 + 'links': (Links,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'data': 'data', # noqa: E501 + 'meta': 'meta', # noqa: E501 + 'links': 'links', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, data, *args, **kwargs): # noqa: E501 + """GetApiResourceResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + data (ApiResource): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (Meta): [optional] # noqa: E501 + links (Links): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, data, *args, **kwargs): # noqa: E501 + """GetApiResourceResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + data (ApiResource): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (Meta): [optional] # noqa: E501 + links (Links): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/get_api_response.py b/src/apideck/model/get_api_response.py new file mode 100644 index 0000000000..8b22bc34d1 --- /dev/null +++ b/src/apideck/model/get_api_response.py @@ -0,0 +1,291 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.api import Api + from apideck.model.links import Links + from apideck.model.meta import Meta + globals()['Api'] = Api + globals()['Links'] = Links + globals()['Meta'] = Meta + + +class GetApiResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'data': (Api,), # noqa: E501 + 'meta': (Meta,), # noqa: E501 + 'links': (Links,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'data': 'data', # noqa: E501 + 'meta': 'meta', # noqa: E501 + 'links': 'links', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, data, *args, **kwargs): # noqa: E501 + """GetApiResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + data (Api): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (Meta): [optional] # noqa: E501 + links (Links): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, data, *args, **kwargs): # noqa: E501 + """GetApiResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + data (Api): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (Meta): [optional] # noqa: E501 + links (Links): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/get_apis_response.py b/src/apideck/model/get_apis_response.py new file mode 100644 index 0000000000..9718b30e14 --- /dev/null +++ b/src/apideck/model/get_apis_response.py @@ -0,0 +1,291 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.api import Api + from apideck.model.links import Links + from apideck.model.meta import Meta + globals()['Api'] = Api + globals()['Links'] = Links + globals()['Meta'] = Meta + + +class GetApisResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'data': ([Api],), # noqa: E501 + 'meta': (Meta,), # noqa: E501 + 'links': (Links,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'data': 'data', # noqa: E501 + 'meta': 'meta', # noqa: E501 + 'links': 'links', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, data, *args, **kwargs): # noqa: E501 + """GetApisResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + data ([Api]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (Meta): [optional] # noqa: E501 + links (Links): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, data, *args, **kwargs): # noqa: E501 + """GetApisResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + data ([Api]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (Meta): [optional] # noqa: E501 + links (Links): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/get_applicant_response.py b/src/apideck/model/get_applicant_response.py new file mode 100644 index 0000000000..d0c42cb887 --- /dev/null +++ b/src/apideck/model/get_applicant_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.applicant import Applicant + globals()['Applicant'] = Applicant + + +class GetApplicantResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (Applicant,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetApplicantResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (Applicant): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetApplicantResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (Applicant): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/get_applicants_response.py b/src/apideck/model/get_applicants_response.py new file mode 100644 index 0000000000..8461fb1a5d --- /dev/null +++ b/src/apideck/model/get_applicants_response.py @@ -0,0 +1,309 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.applicant import Applicant + from apideck.model.links import Links + from apideck.model.meta import Meta + globals()['Applicant'] = Applicant + globals()['Links'] = Links + globals()['Meta'] = Meta + + +class GetApplicantsResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': ([Applicant],), # noqa: E501 + 'meta': (Meta,), # noqa: E501 + 'links': (Links,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + 'meta': 'meta', # noqa: E501 + 'links': 'links', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetApplicantsResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data ([Applicant]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (Meta): [optional] # noqa: E501 + links (Links): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetApplicantsResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data ([Applicant]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (Meta): [optional] # noqa: E501 + links (Links): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/get_balance_sheet_response.py b/src/apideck/model/get_balance_sheet_response.py new file mode 100644 index 0000000000..03ed33e034 --- /dev/null +++ b/src/apideck/model/get_balance_sheet_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.balance_sheet import BalanceSheet + globals()['BalanceSheet'] = BalanceSheet + + +class GetBalanceSheetResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (BalanceSheet,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetBalanceSheetResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (BalanceSheet): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetBalanceSheetResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (BalanceSheet): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/get_bill_response.py b/src/apideck/model/get_bill_response.py new file mode 100644 index 0000000000..f67ee01aa9 --- /dev/null +++ b/src/apideck/model/get_bill_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.bill import Bill + globals()['Bill'] = Bill + + +class GetBillResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (Bill,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetBillResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (Bill): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetBillResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (Bill): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/get_bills_response.py b/src/apideck/model/get_bills_response.py new file mode 100644 index 0000000000..b0627f3083 --- /dev/null +++ b/src/apideck/model/get_bills_response.py @@ -0,0 +1,309 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.bill import Bill + from apideck.model.links import Links + from apideck.model.meta import Meta + globals()['Bill'] = Bill + globals()['Links'] = Links + globals()['Meta'] = Meta + + +class GetBillsResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': ([Bill],), # noqa: E501 + 'meta': (Meta,), # noqa: E501 + 'links': (Links,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + 'meta': 'meta', # noqa: E501 + 'links': 'links', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetBillsResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data ([Bill]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (Meta): [optional] # noqa: E501 + links (Links): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetBillsResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data ([Bill]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (Meta): [optional] # noqa: E501 + links (Links): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/get_companies_response.py b/src/apideck/model/get_companies_response.py new file mode 100644 index 0000000000..f5682396fa --- /dev/null +++ b/src/apideck/model/get_companies_response.py @@ -0,0 +1,309 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.company import Company + from apideck.model.links import Links + from apideck.model.meta import Meta + globals()['Company'] = Company + globals()['Links'] = Links + globals()['Meta'] = Meta + + +class GetCompaniesResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': ([Company],), # noqa: E501 + 'meta': (Meta,), # noqa: E501 + 'links': (Links,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + 'meta': 'meta', # noqa: E501 + 'links': 'links', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetCompaniesResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data ([Company]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (Meta): [optional] # noqa: E501 + links (Links): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetCompaniesResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data ([Company]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (Meta): [optional] # noqa: E501 + links (Links): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/get_company_info_response.py b/src/apideck/model/get_company_info_response.py new file mode 100644 index 0000000000..cd15e02398 --- /dev/null +++ b/src/apideck/model/get_company_info_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.company_info import CompanyInfo + globals()['CompanyInfo'] = CompanyInfo + + +class GetCompanyInfoResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (CompanyInfo,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetCompanyInfoResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (CompanyInfo): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetCompanyInfoResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (CompanyInfo): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/get_company_response.py b/src/apideck/model/get_company_response.py new file mode 100644 index 0000000000..a49b8a9c66 --- /dev/null +++ b/src/apideck/model/get_company_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.company import Company + globals()['Company'] = Company + + +class GetCompanyResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (Company,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetCompanyResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (Company): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetCompanyResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (Company): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/get_connection_response.py b/src/apideck/model/get_connection_response.py new file mode 100644 index 0000000000..8627946772 --- /dev/null +++ b/src/apideck/model/get_connection_response.py @@ -0,0 +1,279 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.connection import Connection + globals()['Connection'] = Connection + + +class GetConnectionResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'data': (Connection,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, data, *args, **kwargs): # noqa: E501 + """GetConnectionResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + data (Connection): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, data, *args, **kwargs): # noqa: E501 + """GetConnectionResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + data (Connection): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/get_connections_response.py b/src/apideck/model/get_connections_response.py new file mode 100644 index 0000000000..ecd6b0c216 --- /dev/null +++ b/src/apideck/model/get_connections_response.py @@ -0,0 +1,279 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.connection import Connection + globals()['Connection'] = Connection + + +class GetConnectionsResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'data': ([Connection],), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, data, *args, **kwargs): # noqa: E501 + """GetConnectionsResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + data ([Connection]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, data, *args, **kwargs): # noqa: E501 + """GetConnectionsResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + data ([Connection]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/get_connector_resource_response.py b/src/apideck/model/get_connector_resource_response.py new file mode 100644 index 0000000000..ec6e6348b4 --- /dev/null +++ b/src/apideck/model/get_connector_resource_response.py @@ -0,0 +1,291 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.connector_resource import ConnectorResource + from apideck.model.links import Links + from apideck.model.meta import Meta + globals()['ConnectorResource'] = ConnectorResource + globals()['Links'] = Links + globals()['Meta'] = Meta + + +class GetConnectorResourceResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'data': (ConnectorResource,), # noqa: E501 + 'meta': (Meta,), # noqa: E501 + 'links': (Links,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'data': 'data', # noqa: E501 + 'meta': 'meta', # noqa: E501 + 'links': 'links', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, data, *args, **kwargs): # noqa: E501 + """GetConnectorResourceResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + data (ConnectorResource): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (Meta): [optional] # noqa: E501 + links (Links): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, data, *args, **kwargs): # noqa: E501 + """GetConnectorResourceResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + data (ConnectorResource): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (Meta): [optional] # noqa: E501 + links (Links): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/get_connector_response.py b/src/apideck/model/get_connector_response.py new file mode 100644 index 0000000000..85077a22a1 --- /dev/null +++ b/src/apideck/model/get_connector_response.py @@ -0,0 +1,291 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.connector import Connector + from apideck.model.links import Links + from apideck.model.meta import Meta + globals()['Connector'] = Connector + globals()['Links'] = Links + globals()['Meta'] = Meta + + +class GetConnectorResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'data': (Connector,), # noqa: E501 + 'meta': (Meta,), # noqa: E501 + 'links': (Links,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'data': 'data', # noqa: E501 + 'meta': 'meta', # noqa: E501 + 'links': 'links', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, data, *args, **kwargs): # noqa: E501 + """GetConnectorResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + data (Connector): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (Meta): [optional] # noqa: E501 + links (Links): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, data, *args, **kwargs): # noqa: E501 + """GetConnectorResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + data (Connector): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (Meta): [optional] # noqa: E501 + links (Links): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/get_connectors_response.py b/src/apideck/model/get_connectors_response.py new file mode 100644 index 0000000000..264523ef4f --- /dev/null +++ b/src/apideck/model/get_connectors_response.py @@ -0,0 +1,291 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.connector import Connector + from apideck.model.links import Links + from apideck.model.meta import Meta + globals()['Connector'] = Connector + globals()['Links'] = Links + globals()['Meta'] = Meta + + +class GetConnectorsResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'data': ([Connector],), # noqa: E501 + 'meta': (Meta,), # noqa: E501 + 'links': (Links,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'data': 'data', # noqa: E501 + 'meta': 'meta', # noqa: E501 + 'links': 'links', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, data, *args, **kwargs): # noqa: E501 + """GetConnectorsResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + data ([Connector]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (Meta): [optional] # noqa: E501 + links (Links): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, data, *args, **kwargs): # noqa: E501 + """GetConnectorsResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + data ([Connector]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (Meta): [optional] # noqa: E501 + links (Links): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/get_consumer_response.py b/src/apideck/model/get_consumer_response.py new file mode 100644 index 0000000000..257b549191 --- /dev/null +++ b/src/apideck/model/get_consumer_response.py @@ -0,0 +1,279 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.consumer import Consumer + globals()['Consumer'] = Consumer + + +class GetConsumerResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'data': (Consumer,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, data, *args, **kwargs): # noqa: E501 + """GetConsumerResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + data (Consumer): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, data, *args, **kwargs): # noqa: E501 + """GetConsumerResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + data (Consumer): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/get_consumers_response.py b/src/apideck/model/get_consumers_response.py new file mode 100644 index 0000000000..b36a8da901 --- /dev/null +++ b/src/apideck/model/get_consumers_response.py @@ -0,0 +1,291 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.get_consumers_response_data import GetConsumersResponseData + from apideck.model.links import Links + from apideck.model.meta import Meta + globals()['GetConsumersResponseData'] = GetConsumersResponseData + globals()['Links'] = Links + globals()['Meta'] = Meta + + +class GetConsumersResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'data': ([GetConsumersResponseData],), # noqa: E501 + 'meta': (Meta,), # noqa: E501 + 'links': (Links,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'data': 'data', # noqa: E501 + 'meta': 'meta', # noqa: E501 + 'links': 'links', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, data, *args, **kwargs): # noqa: E501 + """GetConsumersResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + data ([GetConsumersResponseData]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (Meta): [optional] # noqa: E501 + links (Links): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, data, *args, **kwargs): # noqa: E501 + """GetConsumersResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + data ([GetConsumersResponseData]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (Meta): [optional] # noqa: E501 + links (Links): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/get_consumers_response_data.py b/src/apideck/model/get_consumers_response_data.py new file mode 100644 index 0000000000..1ba6bbc0ee --- /dev/null +++ b/src/apideck/model/get_consumers_response_data.py @@ -0,0 +1,295 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.consumer_metadata import ConsumerMetadata + from apideck.model.request_count_allocation import RequestCountAllocation + globals()['ConsumerMetadata'] = ConsumerMetadata + globals()['RequestCountAllocation'] = RequestCountAllocation + + +class GetConsumersResponseData(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'consumer_id': (str,), # noqa: E501 + 'application_id': (str,), # noqa: E501 + 'metadata': (ConsumerMetadata,), # noqa: E501 + 'aggregated_request_count': (float,), # noqa: E501 + 'request_counts': (RequestCountAllocation,), # noqa: E501 + 'created': (str,), # noqa: E501 + 'modified': (str,), # noqa: E501 + 'request_count_updated': (str,), # noqa: E501 + 'services': ([str],), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'consumer_id': 'consumer_id', # noqa: E501 + 'application_id': 'application_id', # noqa: E501 + 'metadata': 'metadata', # noqa: E501 + 'aggregated_request_count': 'aggregated_request_count', # noqa: E501 + 'request_counts': 'request_counts', # noqa: E501 + 'created': 'created', # noqa: E501 + 'modified': 'modified', # noqa: E501 + 'request_count_updated': 'request_count_updated', # noqa: E501 + 'services': 'services', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """GetConsumersResponseData - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + consumer_id (str): [optional] # noqa: E501 + application_id (str): [optional] # noqa: E501 + metadata (ConsumerMetadata): [optional] # noqa: E501 + aggregated_request_count (float): [optional] # noqa: E501 + request_counts (RequestCountAllocation): [optional] # noqa: E501 + created (str): [optional] # noqa: E501 + modified (str): [optional] # noqa: E501 + request_count_updated (str): [optional] # noqa: E501 + services ([str]): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """GetConsumersResponseData - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + consumer_id (str): [optional] # noqa: E501 + application_id (str): [optional] # noqa: E501 + metadata (ConsumerMetadata): [optional] # noqa: E501 + aggregated_request_count (float): [optional] # noqa: E501 + request_counts (RequestCountAllocation): [optional] # noqa: E501 + created (str): [optional] # noqa: E501 + modified (str): [optional] # noqa: E501 + request_count_updated (str): [optional] # noqa: E501 + services ([str]): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/get_contact_response.py b/src/apideck/model/get_contact_response.py new file mode 100644 index 0000000000..8eb29357a8 --- /dev/null +++ b/src/apideck/model/get_contact_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.contact import Contact + globals()['Contact'] = Contact + + +class GetContactResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (Contact,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetContactResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (Contact): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetContactResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (Contact): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/get_contacts_response.py b/src/apideck/model/get_contacts_response.py new file mode 100644 index 0000000000..094bf703b1 --- /dev/null +++ b/src/apideck/model/get_contacts_response.py @@ -0,0 +1,309 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.contact import Contact + from apideck.model.links import Links + from apideck.model.meta import Meta + globals()['Contact'] = Contact + globals()['Links'] = Links + globals()['Meta'] = Meta + + +class GetContactsResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': ([Contact],), # noqa: E501 + 'meta': (Meta,), # noqa: E501 + 'links': (Links,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + 'meta': 'meta', # noqa: E501 + 'links': 'links', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetContactsResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data ([Contact]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (Meta): [optional] # noqa: E501 + links (Links): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetContactsResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data ([Contact]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (Meta): [optional] # noqa: E501 + links (Links): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/get_credit_note_response.py b/src/apideck/model/get_credit_note_response.py new file mode 100644 index 0000000000..94359eb0cb --- /dev/null +++ b/src/apideck/model/get_credit_note_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.credit_note import CreditNote + globals()['CreditNote'] = CreditNote + + +class GetCreditNoteResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (CreditNote,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetCreditNoteResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (CreditNote): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetCreditNoteResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (CreditNote): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/get_credit_notes_response.py b/src/apideck/model/get_credit_notes_response.py new file mode 100644 index 0000000000..5d3172525b --- /dev/null +++ b/src/apideck/model/get_credit_notes_response.py @@ -0,0 +1,309 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.credit_note import CreditNote + from apideck.model.links import Links + from apideck.model.meta import Meta + globals()['CreditNote'] = CreditNote + globals()['Links'] = Links + globals()['Meta'] = Meta + + +class GetCreditNotesResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': ([CreditNote],), # noqa: E501 + 'meta': (Meta,), # noqa: E501 + 'links': (Links,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + 'meta': 'meta', # noqa: E501 + 'links': 'links', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetCreditNotesResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data ([CreditNote]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (Meta): [optional] # noqa: E501 + links (Links): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetCreditNotesResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data ([CreditNote]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (Meta): [optional] # noqa: E501 + links (Links): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/get_customer_response.py b/src/apideck/model/get_customer_response.py new file mode 100644 index 0000000000..f7292e602b --- /dev/null +++ b/src/apideck/model/get_customer_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.accounting_customer import AccountingCustomer + globals()['AccountingCustomer'] = AccountingCustomer + + +class GetCustomerResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (AccountingCustomer,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetCustomerResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (AccountingCustomer): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetCustomerResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (AccountingCustomer): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/get_customer_support_customer_response.py b/src/apideck/model/get_customer_support_customer_response.py new file mode 100644 index 0000000000..2c3cc77426 --- /dev/null +++ b/src/apideck/model/get_customer_support_customer_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.customer_support_customer import CustomerSupportCustomer + globals()['CustomerSupportCustomer'] = CustomerSupportCustomer + + +class GetCustomerSupportCustomerResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (CustomerSupportCustomer,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetCustomerSupportCustomerResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (CustomerSupportCustomer): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetCustomerSupportCustomerResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (CustomerSupportCustomer): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/get_customer_support_customers_response.py b/src/apideck/model/get_customer_support_customers_response.py new file mode 100644 index 0000000000..29e533a3b0 --- /dev/null +++ b/src/apideck/model/get_customer_support_customers_response.py @@ -0,0 +1,309 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.customer_support_customer import CustomerSupportCustomer + from apideck.model.links import Links + from apideck.model.meta import Meta + globals()['CustomerSupportCustomer'] = CustomerSupportCustomer + globals()['Links'] = Links + globals()['Meta'] = Meta + + +class GetCustomerSupportCustomersResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': ([CustomerSupportCustomer],), # noqa: E501 + 'meta': (Meta,), # noqa: E501 + 'links': (Links,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + 'meta': 'meta', # noqa: E501 + 'links': 'links', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetCustomerSupportCustomersResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data ([CustomerSupportCustomer]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (Meta): [optional] # noqa: E501 + links (Links): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetCustomerSupportCustomersResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data ([CustomerSupportCustomer]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (Meta): [optional] # noqa: E501 + links (Links): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/get_customers_response.py b/src/apideck/model/get_customers_response.py new file mode 100644 index 0000000000..e4a846805e --- /dev/null +++ b/src/apideck/model/get_customers_response.py @@ -0,0 +1,309 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.accounting_customer import AccountingCustomer + from apideck.model.links import Links + from apideck.model.meta import Meta + globals()['AccountingCustomer'] = AccountingCustomer + globals()['Links'] = Links + globals()['Meta'] = Meta + + +class GetCustomersResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': ([AccountingCustomer],), # noqa: E501 + 'meta': (Meta,), # noqa: E501 + 'links': (Links,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + 'meta': 'meta', # noqa: E501 + 'links': 'links', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetCustomersResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data ([AccountingCustomer]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (Meta): [optional] # noqa: E501 + links (Links): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetCustomersResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data ([AccountingCustomer]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (Meta): [optional] # noqa: E501 + links (Links): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/get_department_response.py b/src/apideck/model/get_department_response.py new file mode 100644 index 0000000000..5e7cd2b92e --- /dev/null +++ b/src/apideck/model/get_department_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.department import Department + globals()['Department'] = Department + + +class GetDepartmentResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (Department,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetDepartmentResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (Department): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetDepartmentResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (Department): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/get_departments_response.py b/src/apideck/model/get_departments_response.py new file mode 100644 index 0000000000..d6edf8efab --- /dev/null +++ b/src/apideck/model/get_departments_response.py @@ -0,0 +1,309 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.department import Department + from apideck.model.links import Links + from apideck.model.meta import Meta + globals()['Department'] = Department + globals()['Links'] = Links + globals()['Meta'] = Meta + + +class GetDepartmentsResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': ([Department],), # noqa: E501 + 'meta': (Meta,), # noqa: E501 + 'links': (Links,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + 'meta': 'meta', # noqa: E501 + 'links': 'links', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetDepartmentsResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data ([Department]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (Meta): [optional] # noqa: E501 + links (Links): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetDepartmentsResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data ([Department]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (Meta): [optional] # noqa: E501 + links (Links): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/get_drive_group_response.py b/src/apideck/model/get_drive_group_response.py new file mode 100644 index 0000000000..b18ecb4f80 --- /dev/null +++ b/src/apideck/model/get_drive_group_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.drive_group import DriveGroup + globals()['DriveGroup'] = DriveGroup + + +class GetDriveGroupResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (DriveGroup,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetDriveGroupResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (DriveGroup): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetDriveGroupResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (DriveGroup): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/get_drive_groups_response.py b/src/apideck/model/get_drive_groups_response.py new file mode 100644 index 0000000000..689003e042 --- /dev/null +++ b/src/apideck/model/get_drive_groups_response.py @@ -0,0 +1,309 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.drive_group import DriveGroup + from apideck.model.links import Links + from apideck.model.meta import Meta + globals()['DriveGroup'] = DriveGroup + globals()['Links'] = Links + globals()['Meta'] = Meta + + +class GetDriveGroupsResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': ([DriveGroup],), # noqa: E501 + 'meta': (Meta,), # noqa: E501 + 'links': (Links,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + 'meta': 'meta', # noqa: E501 + 'links': 'links', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetDriveGroupsResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data ([DriveGroup]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (Meta): [optional] # noqa: E501 + links (Links): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetDriveGroupsResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data ([DriveGroup]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (Meta): [optional] # noqa: E501 + links (Links): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/get_drive_response.py b/src/apideck/model/get_drive_response.py new file mode 100644 index 0000000000..4b4bcef944 --- /dev/null +++ b/src/apideck/model/get_drive_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.drive import Drive + globals()['Drive'] = Drive + + +class GetDriveResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (Drive,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetDriveResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (Drive): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetDriveResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (Drive): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/get_drives_response.py b/src/apideck/model/get_drives_response.py new file mode 100644 index 0000000000..dbb8cc8673 --- /dev/null +++ b/src/apideck/model/get_drives_response.py @@ -0,0 +1,309 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.drive import Drive + from apideck.model.links import Links + from apideck.model.meta import Meta + globals()['Drive'] = Drive + globals()['Links'] = Links + globals()['Meta'] = Meta + + +class GetDrivesResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': ([Drive],), # noqa: E501 + 'meta': (Meta,), # noqa: E501 + 'links': (Links,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + 'meta': 'meta', # noqa: E501 + 'links': 'links', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetDrivesResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data ([Drive]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (Meta): [optional] # noqa: E501 + links (Links): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetDrivesResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data ([Drive]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (Meta): [optional] # noqa: E501 + links (Links): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/get_employee_payroll_response.py b/src/apideck/model/get_employee_payroll_response.py new file mode 100644 index 0000000000..d238781790 --- /dev/null +++ b/src/apideck/model/get_employee_payroll_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.employee_payroll import EmployeePayroll + globals()['EmployeePayroll'] = EmployeePayroll + + +class GetEmployeePayrollResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (EmployeePayroll,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetEmployeePayrollResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (EmployeePayroll): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetEmployeePayrollResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (EmployeePayroll): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/get_employee_payrolls_response.py b/src/apideck/model/get_employee_payrolls_response.py new file mode 100644 index 0000000000..7c56447cf9 --- /dev/null +++ b/src/apideck/model/get_employee_payrolls_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.employee_payrolls import EmployeePayrolls + globals()['EmployeePayrolls'] = EmployeePayrolls + + +class GetEmployeePayrollsResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (EmployeePayrolls,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetEmployeePayrollsResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (EmployeePayrolls): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetEmployeePayrollsResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (EmployeePayrolls): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/get_employee_response.py b/src/apideck/model/get_employee_response.py new file mode 100644 index 0000000000..58abcf2e74 --- /dev/null +++ b/src/apideck/model/get_employee_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.employee import Employee + globals()['Employee'] = Employee + + +class GetEmployeeResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (Employee,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetEmployeeResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (Employee): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetEmployeeResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (Employee): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/get_employee_schedules_response.py b/src/apideck/model/get_employee_schedules_response.py new file mode 100644 index 0000000000..6fdb579f23 --- /dev/null +++ b/src/apideck/model/get_employee_schedules_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.employee_schedules import EmployeeSchedules + globals()['EmployeeSchedules'] = EmployeeSchedules + + +class GetEmployeeSchedulesResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (EmployeeSchedules,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetEmployeeSchedulesResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (EmployeeSchedules): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetEmployeeSchedulesResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (EmployeeSchedules): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/get_employees_response.py b/src/apideck/model/get_employees_response.py new file mode 100644 index 0000000000..e6575a1c20 --- /dev/null +++ b/src/apideck/model/get_employees_response.py @@ -0,0 +1,309 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.employee import Employee + from apideck.model.links import Links + from apideck.model.meta import Meta + globals()['Employee'] = Employee + globals()['Links'] = Links + globals()['Meta'] = Meta + + +class GetEmployeesResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': ([Employee],), # noqa: E501 + 'meta': (Meta,), # noqa: E501 + 'links': (Links,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + 'meta': 'meta', # noqa: E501 + 'links': 'links', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetEmployeesResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data ([Employee]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (Meta): [optional] # noqa: E501 + links (Links): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetEmployeesResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data ([Employee]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (Meta): [optional] # noqa: E501 + links (Links): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/get_file_response.py b/src/apideck/model/get_file_response.py new file mode 100644 index 0000000000..3b77ed7869 --- /dev/null +++ b/src/apideck/model/get_file_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_file import UnifiedFile + globals()['UnifiedFile'] = UnifiedFile + + +class GetFileResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedFile,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetFileResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedFile): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetFileResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedFile): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/get_files_response.py b/src/apideck/model/get_files_response.py new file mode 100644 index 0000000000..520f4a650f --- /dev/null +++ b/src/apideck/model/get_files_response.py @@ -0,0 +1,309 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.links import Links + from apideck.model.meta import Meta + from apideck.model.unified_file import UnifiedFile + globals()['Links'] = Links + globals()['Meta'] = Meta + globals()['UnifiedFile'] = UnifiedFile + + +class GetFilesResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': ([UnifiedFile],), # noqa: E501 + 'meta': (Meta,), # noqa: E501 + 'links': (Links,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + 'meta': 'meta', # noqa: E501 + 'links': 'links', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetFilesResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data ([UnifiedFile]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (Meta): [optional] # noqa: E501 + links (Links): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetFilesResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data ([UnifiedFile]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (Meta): [optional] # noqa: E501 + links (Links): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/get_folder_response.py b/src/apideck/model/get_folder_response.py new file mode 100644 index 0000000000..2d1816ab9a --- /dev/null +++ b/src/apideck/model/get_folder_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.folder import Folder + globals()['Folder'] = Folder + + +class GetFolderResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (Folder,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetFolderResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (Folder): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetFolderResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (Folder): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/get_folders_response.py b/src/apideck/model/get_folders_response.py new file mode 100644 index 0000000000..8e69b00b3b --- /dev/null +++ b/src/apideck/model/get_folders_response.py @@ -0,0 +1,309 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.folder import Folder + from apideck.model.links import Links + from apideck.model.meta import Meta + globals()['Folder'] = Folder + globals()['Links'] = Links + globals()['Meta'] = Meta + + +class GetFoldersResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': ([Folder],), # noqa: E501 + 'meta': (Meta,), # noqa: E501 + 'links': (Links,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + 'meta': 'meta', # noqa: E501 + 'links': 'links', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetFoldersResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data ([Folder]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (Meta): [optional] # noqa: E501 + links (Links): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetFoldersResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data ([Folder]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (Meta): [optional] # noqa: E501 + links (Links): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/get_hris_companies_response.py b/src/apideck/model/get_hris_companies_response.py new file mode 100644 index 0000000000..7f582b6654 --- /dev/null +++ b/src/apideck/model/get_hris_companies_response.py @@ -0,0 +1,309 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.hris_company import HrisCompany + from apideck.model.links import Links + from apideck.model.meta import Meta + globals()['HrisCompany'] = HrisCompany + globals()['Links'] = Links + globals()['Meta'] = Meta + + +class GetHrisCompaniesResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': ([HrisCompany],), # noqa: E501 + 'meta': (Meta,), # noqa: E501 + 'links': (Links,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + 'meta': 'meta', # noqa: E501 + 'links': 'links', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetHrisCompaniesResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data ([HrisCompany]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (Meta): [optional] # noqa: E501 + links (Links): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetHrisCompaniesResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data ([HrisCompany]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (Meta): [optional] # noqa: E501 + links (Links): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/get_hris_company_response.py b/src/apideck/model/get_hris_company_response.py new file mode 100644 index 0000000000..7b11bb15da --- /dev/null +++ b/src/apideck/model/get_hris_company_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.hris_company import HrisCompany + globals()['HrisCompany'] = HrisCompany + + +class GetHrisCompanyResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (HrisCompany,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetHrisCompanyResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (HrisCompany): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetHrisCompanyResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (HrisCompany): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/get_hris_job_response.py b/src/apideck/model/get_hris_job_response.py new file mode 100644 index 0000000000..e1d15cd732 --- /dev/null +++ b/src/apideck/model/get_hris_job_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.hris_job import HrisJob + globals()['HrisJob'] = HrisJob + + +class GetHrisJobResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (HrisJob,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetHrisJobResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (HrisJob): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetHrisJobResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (HrisJob): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/get_hris_jobs_response.py b/src/apideck/model/get_hris_jobs_response.py new file mode 100644 index 0000000000..1df9c2c44c --- /dev/null +++ b/src/apideck/model/get_hris_jobs_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.hris_jobs import HrisJobs + globals()['HrisJobs'] = HrisJobs + + +class GetHrisJobsResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (HrisJobs,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetHrisJobsResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (HrisJobs): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetHrisJobsResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (HrisJobs): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/get_invoice_item_response.py b/src/apideck/model/get_invoice_item_response.py new file mode 100644 index 0000000000..47013ca561 --- /dev/null +++ b/src/apideck/model/get_invoice_item_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.invoice_item import InvoiceItem + globals()['InvoiceItem'] = InvoiceItem + + +class GetInvoiceItemResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (InvoiceItem,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetInvoiceItemResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (InvoiceItem): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetInvoiceItemResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (InvoiceItem): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/get_invoice_items_response.py b/src/apideck/model/get_invoice_items_response.py new file mode 100644 index 0000000000..2b9974dfea --- /dev/null +++ b/src/apideck/model/get_invoice_items_response.py @@ -0,0 +1,309 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.invoice_item import InvoiceItem + from apideck.model.links import Links + from apideck.model.meta import Meta + globals()['InvoiceItem'] = InvoiceItem + globals()['Links'] = Links + globals()['Meta'] = Meta + + +class GetInvoiceItemsResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': ([InvoiceItem],), # noqa: E501 + 'meta': (Meta,), # noqa: E501 + 'links': (Links,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + 'meta': 'meta', # noqa: E501 + 'links': 'links', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetInvoiceItemsResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data ([InvoiceItem]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (Meta): [optional] # noqa: E501 + links (Links): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetInvoiceItemsResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data ([InvoiceItem]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (Meta): [optional] # noqa: E501 + links (Links): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/get_invoice_response.py b/src/apideck/model/get_invoice_response.py new file mode 100644 index 0000000000..5551f28878 --- /dev/null +++ b/src/apideck/model/get_invoice_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.invoice import Invoice + globals()['Invoice'] = Invoice + + +class GetInvoiceResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (Invoice,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetInvoiceResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (Invoice): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetInvoiceResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (Invoice): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/get_invoices_response.py b/src/apideck/model/get_invoices_response.py new file mode 100644 index 0000000000..ed0c508f57 --- /dev/null +++ b/src/apideck/model/get_invoices_response.py @@ -0,0 +1,309 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.invoice import Invoice + from apideck.model.links import Links + from apideck.model.meta import Meta + globals()['Invoice'] = Invoice + globals()['Links'] = Links + globals()['Meta'] = Meta + + +class GetInvoicesResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': ([Invoice],), # noqa: E501 + 'meta': (Meta,), # noqa: E501 + 'links': (Links,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + 'meta': 'meta', # noqa: E501 + 'links': 'links', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetInvoicesResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data ([Invoice]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (Meta): [optional] # noqa: E501 + links (Links): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetInvoicesResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data ([Invoice]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (Meta): [optional] # noqa: E501 + links (Links): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/get_item_response.py b/src/apideck/model/get_item_response.py new file mode 100644 index 0000000000..78213133bd --- /dev/null +++ b/src/apideck/model/get_item_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.item import Item + globals()['Item'] = Item + + +class GetItemResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (Item,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetItemResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (Item): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetItemResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (Item): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/get_items_response.py b/src/apideck/model/get_items_response.py new file mode 100644 index 0000000000..009e300a80 --- /dev/null +++ b/src/apideck/model/get_items_response.py @@ -0,0 +1,309 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.item import Item + from apideck.model.links import Links + from apideck.model.meta import Meta + globals()['Item'] = Item + globals()['Links'] = Links + globals()['Meta'] = Meta + + +class GetItemsResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': ([Item],), # noqa: E501 + 'meta': (Meta,), # noqa: E501 + 'links': (Links,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + 'meta': 'meta', # noqa: E501 + 'links': 'links', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetItemsResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data ([Item]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (Meta): [optional] # noqa: E501 + links (Links): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetItemsResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data ([Item]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (Meta): [optional] # noqa: E501 + links (Links): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/get_job_response.py b/src/apideck/model/get_job_response.py new file mode 100644 index 0000000000..9b0175b6a8 --- /dev/null +++ b/src/apideck/model/get_job_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.job import Job + globals()['Job'] = Job + + +class GetJobResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (Job,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetJobResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (Job): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetJobResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (Job): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/get_jobs_response.py b/src/apideck/model/get_jobs_response.py new file mode 100644 index 0000000000..0c34cfcc57 --- /dev/null +++ b/src/apideck/model/get_jobs_response.py @@ -0,0 +1,309 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.job import Job + from apideck.model.links import Links + from apideck.model.meta import Meta + globals()['Job'] = Job + globals()['Links'] = Links + globals()['Meta'] = Meta + + +class GetJobsResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': ([Job],), # noqa: E501 + 'meta': (Meta,), # noqa: E501 + 'links': (Links,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + 'meta': 'meta', # noqa: E501 + 'links': 'links', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetJobsResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data ([Job]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (Meta): [optional] # noqa: E501 + links (Links): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetJobsResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data ([Job]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (Meta): [optional] # noqa: E501 + links (Links): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/get_lead_response.py b/src/apideck/model/get_lead_response.py new file mode 100644 index 0000000000..c4156467b7 --- /dev/null +++ b/src/apideck/model/get_lead_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.lead import Lead + globals()['Lead'] = Lead + + +class GetLeadResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (Lead,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetLeadResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (Lead): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetLeadResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (Lead): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/get_leads_response.py b/src/apideck/model/get_leads_response.py new file mode 100644 index 0000000000..3e6ce87b93 --- /dev/null +++ b/src/apideck/model/get_leads_response.py @@ -0,0 +1,309 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.lead import Lead + from apideck.model.links import Links + from apideck.model.meta import Meta + globals()['Lead'] = Lead + globals()['Links'] = Links + globals()['Meta'] = Meta + + +class GetLeadsResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': ([Lead],), # noqa: E501 + 'meta': (Meta,), # noqa: E501 + 'links': (Links,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + 'meta': 'meta', # noqa: E501 + 'links': 'links', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetLeadsResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data ([Lead]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (Meta): [optional] # noqa: E501 + links (Links): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetLeadsResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data ([Lead]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (Meta): [optional] # noqa: E501 + links (Links): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/get_ledger_account_response.py b/src/apideck/model/get_ledger_account_response.py new file mode 100644 index 0000000000..a7aa8ec637 --- /dev/null +++ b/src/apideck/model/get_ledger_account_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.ledger_account import LedgerAccount + globals()['LedgerAccount'] = LedgerAccount + + +class GetLedgerAccountResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (LedgerAccount,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetLedgerAccountResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (LedgerAccount): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetLedgerAccountResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (LedgerAccount): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/get_ledger_accounts_response.py b/src/apideck/model/get_ledger_accounts_response.py new file mode 100644 index 0000000000..1832c4258c --- /dev/null +++ b/src/apideck/model/get_ledger_accounts_response.py @@ -0,0 +1,309 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.ledger_account import LedgerAccount + from apideck.model.links import Links + from apideck.model.meta import Meta + globals()['LedgerAccount'] = LedgerAccount + globals()['Links'] = Links + globals()['Meta'] = Meta + + +class GetLedgerAccountsResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': ([LedgerAccount],), # noqa: E501 + 'meta': (Meta,), # noqa: E501 + 'links': (Links,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + 'meta': 'meta', # noqa: E501 + 'links': 'links', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetLedgerAccountsResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data ([LedgerAccount]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (Meta): [optional] # noqa: E501 + links (Links): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetLedgerAccountsResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data ([LedgerAccount]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (Meta): [optional] # noqa: E501 + links (Links): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/get_location_response.py b/src/apideck/model/get_location_response.py new file mode 100644 index 0000000000..889e4aa280 --- /dev/null +++ b/src/apideck/model/get_location_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.location import Location + globals()['Location'] = Location + + +class GetLocationResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (Location,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetLocationResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (Location): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetLocationResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (Location): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/get_locations_response.py b/src/apideck/model/get_locations_response.py new file mode 100644 index 0000000000..3dc8cc682f --- /dev/null +++ b/src/apideck/model/get_locations_response.py @@ -0,0 +1,309 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.links import Links + from apideck.model.location import Location + from apideck.model.meta import Meta + globals()['Links'] = Links + globals()['Location'] = Location + globals()['Meta'] = Meta + + +class GetLocationsResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': ([Location],), # noqa: E501 + 'meta': (Meta,), # noqa: E501 + 'links': (Links,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + 'meta': 'meta', # noqa: E501 + 'links': 'links', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetLocationsResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data ([Location]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (Meta): [optional] # noqa: E501 + links (Links): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetLocationsResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data ([Location]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (Meta): [optional] # noqa: E501 + links (Links): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/get_logs_response.py b/src/apideck/model/get_logs_response.py new file mode 100644 index 0000000000..af1c04d830 --- /dev/null +++ b/src/apideck/model/get_logs_response.py @@ -0,0 +1,291 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.links import Links + from apideck.model.log import Log + from apideck.model.meta import Meta + globals()['Links'] = Links + globals()['Log'] = Log + globals()['Meta'] = Meta + + +class GetLogsResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'data': ([Log],), # noqa: E501 + 'meta': (Meta,), # noqa: E501 + 'links': (Links,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'data': 'data', # noqa: E501 + 'meta': 'meta', # noqa: E501 + 'links': 'links', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, data, *args, **kwargs): # noqa: E501 + """GetLogsResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + data ([Log]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (Meta): [optional] # noqa: E501 + links (Links): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, data, *args, **kwargs): # noqa: E501 + """GetLogsResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + data ([Log]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (Meta): [optional] # noqa: E501 + links (Links): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/get_merchant_response.py b/src/apideck/model/get_merchant_response.py new file mode 100644 index 0000000000..dcd217d121 --- /dev/null +++ b/src/apideck/model/get_merchant_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.merchant import Merchant + globals()['Merchant'] = Merchant + + +class GetMerchantResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (Merchant,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetMerchantResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (Merchant): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetMerchantResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (Merchant): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/get_merchants_response.py b/src/apideck/model/get_merchants_response.py new file mode 100644 index 0000000000..4936e9223e --- /dev/null +++ b/src/apideck/model/get_merchants_response.py @@ -0,0 +1,309 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.links import Links + from apideck.model.merchant import Merchant + from apideck.model.meta import Meta + globals()['Links'] = Links + globals()['Merchant'] = Merchant + globals()['Meta'] = Meta + + +class GetMerchantsResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': ([Merchant],), # noqa: E501 + 'meta': (Meta,), # noqa: E501 + 'links': (Links,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + 'meta': 'meta', # noqa: E501 + 'links': 'links', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetMerchantsResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data ([Merchant]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (Meta): [optional] # noqa: E501 + links (Links): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetMerchantsResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data ([Merchant]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (Meta): [optional] # noqa: E501 + links (Links): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/get_message_response.py b/src/apideck/model/get_message_response.py new file mode 100644 index 0000000000..a686368dd5 --- /dev/null +++ b/src/apideck/model/get_message_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.message import Message + globals()['Message'] = Message + + +class GetMessageResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (Message,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetMessageResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (Message): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetMessageResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (Message): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/get_messages_response.py b/src/apideck/model/get_messages_response.py new file mode 100644 index 0000000000..a54755fc31 --- /dev/null +++ b/src/apideck/model/get_messages_response.py @@ -0,0 +1,309 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.links import Links + from apideck.model.message import Message + from apideck.model.meta import Meta + globals()['Links'] = Links + globals()['Message'] = Message + globals()['Meta'] = Meta + + +class GetMessagesResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': ([Message],), # noqa: E501 + 'meta': (Meta,), # noqa: E501 + 'links': (Links,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + 'meta': 'meta', # noqa: E501 + 'links': 'links', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetMessagesResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data ([Message]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (Meta): [optional] # noqa: E501 + links (Links): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetMessagesResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data ([Message]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (Meta): [optional] # noqa: E501 + links (Links): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/get_modifier_group_response.py b/src/apideck/model/get_modifier_group_response.py new file mode 100644 index 0000000000..abd55064bd --- /dev/null +++ b/src/apideck/model/get_modifier_group_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.modifier_group import ModifierGroup + globals()['ModifierGroup'] = ModifierGroup + + +class GetModifierGroupResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (ModifierGroup,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetModifierGroupResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (ModifierGroup): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetModifierGroupResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (ModifierGroup): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/get_modifier_groups_response.py b/src/apideck/model/get_modifier_groups_response.py new file mode 100644 index 0000000000..50e20ac01c --- /dev/null +++ b/src/apideck/model/get_modifier_groups_response.py @@ -0,0 +1,309 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.links import Links + from apideck.model.meta import Meta + from apideck.model.modifier_group import ModifierGroup + globals()['Links'] = Links + globals()['Meta'] = Meta + globals()['ModifierGroup'] = ModifierGroup + + +class GetModifierGroupsResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': ([ModifierGroup],), # noqa: E501 + 'meta': (Meta,), # noqa: E501 + 'links': (Links,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + 'meta': 'meta', # noqa: E501 + 'links': 'links', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetModifierGroupsResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data ([ModifierGroup]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (Meta): [optional] # noqa: E501 + links (Links): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetModifierGroupsResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data ([ModifierGroup]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (Meta): [optional] # noqa: E501 + links (Links): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/get_modifier_response.py b/src/apideck/model/get_modifier_response.py new file mode 100644 index 0000000000..f13de5961b --- /dev/null +++ b/src/apideck/model/get_modifier_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.modifier import Modifier + globals()['Modifier'] = Modifier + + +class GetModifierResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (Modifier,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetModifierResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (Modifier): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetModifierResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (Modifier): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/get_modifiers_response.py b/src/apideck/model/get_modifiers_response.py new file mode 100644 index 0000000000..12992fec42 --- /dev/null +++ b/src/apideck/model/get_modifiers_response.py @@ -0,0 +1,309 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.links import Links + from apideck.model.meta import Meta + from apideck.model.modifier import Modifier + globals()['Links'] = Links + globals()['Meta'] = Meta + globals()['Modifier'] = Modifier + + +class GetModifiersResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': ([Modifier],), # noqa: E501 + 'meta': (Meta,), # noqa: E501 + 'links': (Links,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + 'meta': 'meta', # noqa: E501 + 'links': 'links', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetModifiersResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data ([Modifier]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (Meta): [optional] # noqa: E501 + links (Links): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetModifiersResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data ([Modifier]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (Meta): [optional] # noqa: E501 + links (Links): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/get_note_response.py b/src/apideck/model/get_note_response.py new file mode 100644 index 0000000000..8baee3a674 --- /dev/null +++ b/src/apideck/model/get_note_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.note import Note + globals()['Note'] = Note + + +class GetNoteResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (Note,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetNoteResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (Note): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetNoteResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (Note): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/get_notes_response.py b/src/apideck/model/get_notes_response.py new file mode 100644 index 0000000000..4e8d1c2f1c --- /dev/null +++ b/src/apideck/model/get_notes_response.py @@ -0,0 +1,309 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.links import Links + from apideck.model.meta import Meta + from apideck.model.note import Note + globals()['Links'] = Links + globals()['Meta'] = Meta + globals()['Note'] = Note + + +class GetNotesResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': ([Note],), # noqa: E501 + 'meta': (Meta,), # noqa: E501 + 'links': (Links,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + 'meta': 'meta', # noqa: E501 + 'links': 'links', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetNotesResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data ([Note]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (Meta): [optional] # noqa: E501 + links (Links): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetNotesResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data ([Note]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (Meta): [optional] # noqa: E501 + links (Links): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/get_opportunities_response.py b/src/apideck/model/get_opportunities_response.py new file mode 100644 index 0000000000..26ad6079b0 --- /dev/null +++ b/src/apideck/model/get_opportunities_response.py @@ -0,0 +1,309 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.links import Links + from apideck.model.meta import Meta + from apideck.model.opportunity import Opportunity + globals()['Links'] = Links + globals()['Meta'] = Meta + globals()['Opportunity'] = Opportunity + + +class GetOpportunitiesResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': ([Opportunity],), # noqa: E501 + 'meta': (Meta,), # noqa: E501 + 'links': (Links,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + 'meta': 'meta', # noqa: E501 + 'links': 'links', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetOpportunitiesResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data ([Opportunity]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (Meta): [optional] # noqa: E501 + links (Links): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetOpportunitiesResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data ([Opportunity]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (Meta): [optional] # noqa: E501 + links (Links): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/get_opportunity_response.py b/src/apideck/model/get_opportunity_response.py new file mode 100644 index 0000000000..db5013fd4a --- /dev/null +++ b/src/apideck/model/get_opportunity_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.opportunity import Opportunity + globals()['Opportunity'] = Opportunity + + +class GetOpportunityResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (Opportunity,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetOpportunityResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (Opportunity): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetOpportunityResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (Opportunity): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/get_order_response.py b/src/apideck/model/get_order_response.py new file mode 100644 index 0000000000..a67d5200e4 --- /dev/null +++ b/src/apideck/model/get_order_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.order import Order + globals()['Order'] = Order + + +class GetOrderResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (Order,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetOrderResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (Order): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetOrderResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (Order): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/get_order_type_response.py b/src/apideck/model/get_order_type_response.py new file mode 100644 index 0000000000..af7014c9a2 --- /dev/null +++ b/src/apideck/model/get_order_type_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.order_type import OrderType + globals()['OrderType'] = OrderType + + +class GetOrderTypeResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (OrderType,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetOrderTypeResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (OrderType): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetOrderTypeResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (OrderType): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/get_order_types_response.py b/src/apideck/model/get_order_types_response.py new file mode 100644 index 0000000000..9d0cc01c5f --- /dev/null +++ b/src/apideck/model/get_order_types_response.py @@ -0,0 +1,309 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.links import Links + from apideck.model.meta import Meta + from apideck.model.order_type import OrderType + globals()['Links'] = Links + globals()['Meta'] = Meta + globals()['OrderType'] = OrderType + + +class GetOrderTypesResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': ([OrderType],), # noqa: E501 + 'meta': (Meta,), # noqa: E501 + 'links': (Links,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + 'meta': 'meta', # noqa: E501 + 'links': 'links', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetOrderTypesResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data ([OrderType]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (Meta): [optional] # noqa: E501 + links (Links): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetOrderTypesResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data ([OrderType]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (Meta): [optional] # noqa: E501 + links (Links): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/get_orders_response.py b/src/apideck/model/get_orders_response.py new file mode 100644 index 0000000000..334508e11a --- /dev/null +++ b/src/apideck/model/get_orders_response.py @@ -0,0 +1,309 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.links import Links + from apideck.model.meta import Meta + from apideck.model.order import Order + globals()['Links'] = Links + globals()['Meta'] = Meta + globals()['Order'] = Order + + +class GetOrdersResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': ([Order],), # noqa: E501 + 'meta': (Meta,), # noqa: E501 + 'links': (Links,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + 'meta': 'meta', # noqa: E501 + 'links': 'links', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetOrdersResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data ([Order]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (Meta): [optional] # noqa: E501 + links (Links): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetOrdersResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data ([Order]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (Meta): [optional] # noqa: E501 + links (Links): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/get_payment_response.py b/src/apideck/model/get_payment_response.py new file mode 100644 index 0000000000..2bf51689cd --- /dev/null +++ b/src/apideck/model/get_payment_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.payment import Payment + globals()['Payment'] = Payment + + +class GetPaymentResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (Payment,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetPaymentResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (Payment): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetPaymentResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (Payment): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/get_payments_response.py b/src/apideck/model/get_payments_response.py new file mode 100644 index 0000000000..23e2a5d079 --- /dev/null +++ b/src/apideck/model/get_payments_response.py @@ -0,0 +1,309 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.links import Links + from apideck.model.meta import Meta + from apideck.model.payment import Payment + globals()['Links'] = Links + globals()['Meta'] = Meta + globals()['Payment'] = Payment + + +class GetPaymentsResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': ([Payment],), # noqa: E501 + 'meta': (Meta,), # noqa: E501 + 'links': (Links,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + 'meta': 'meta', # noqa: E501 + 'links': 'links', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetPaymentsResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data ([Payment]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (Meta): [optional] # noqa: E501 + links (Links): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetPaymentsResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data ([Payment]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (Meta): [optional] # noqa: E501 + links (Links): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/get_payroll_response.py b/src/apideck/model/get_payroll_response.py new file mode 100644 index 0000000000..98d1cc4514 --- /dev/null +++ b/src/apideck/model/get_payroll_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.payroll import Payroll + globals()['Payroll'] = Payroll + + +class GetPayrollResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (Payroll,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetPayrollResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (Payroll): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetPayrollResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (Payroll): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/get_payrolls_response.py b/src/apideck/model/get_payrolls_response.py new file mode 100644 index 0000000000..5fd5eb035f --- /dev/null +++ b/src/apideck/model/get_payrolls_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.payroll import Payroll + globals()['Payroll'] = Payroll + + +class GetPayrollsResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': ([Payroll],), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetPayrollsResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data ([Payroll]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetPayrollsResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data ([Payroll]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/get_pipeline_response.py b/src/apideck/model/get_pipeline_response.py new file mode 100644 index 0000000000..a5c0d5782e --- /dev/null +++ b/src/apideck/model/get_pipeline_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.pipeline import Pipeline + globals()['Pipeline'] = Pipeline + + +class GetPipelineResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (Pipeline,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetPipelineResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (Pipeline): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetPipelineResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (Pipeline): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/get_pipelines_response.py b/src/apideck/model/get_pipelines_response.py new file mode 100644 index 0000000000..2ea9f1e319 --- /dev/null +++ b/src/apideck/model/get_pipelines_response.py @@ -0,0 +1,309 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.links import Links + from apideck.model.meta import Meta + from apideck.model.pipeline import Pipeline + globals()['Links'] = Links + globals()['Meta'] = Meta + globals()['Pipeline'] = Pipeline + + +class GetPipelinesResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': ([Pipeline],), # noqa: E501 + 'meta': (Meta,), # noqa: E501 + 'links': (Links,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + 'meta': 'meta', # noqa: E501 + 'links': 'links', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetPipelinesResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data ([Pipeline]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (Meta): [optional] # noqa: E501 + links (Links): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetPipelinesResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data ([Pipeline]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (Meta): [optional] # noqa: E501 + links (Links): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/get_pos_payment_response.py b/src/apideck/model/get_pos_payment_response.py new file mode 100644 index 0000000000..2b5b77ca15 --- /dev/null +++ b/src/apideck/model/get_pos_payment_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.pos_payment import PosPayment + globals()['PosPayment'] = PosPayment + + +class GetPosPaymentResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (PosPayment,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetPosPaymentResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (PosPayment): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetPosPaymentResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (PosPayment): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/get_pos_payments_response.py b/src/apideck/model/get_pos_payments_response.py new file mode 100644 index 0000000000..0061694942 --- /dev/null +++ b/src/apideck/model/get_pos_payments_response.py @@ -0,0 +1,309 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.links import Links + from apideck.model.meta import Meta + from apideck.model.pos_payment import PosPayment + globals()['Links'] = Links + globals()['Meta'] = Meta + globals()['PosPayment'] = PosPayment + + +class GetPosPaymentsResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': ([PosPayment],), # noqa: E501 + 'meta': (Meta,), # noqa: E501 + 'links': (Links,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + 'meta': 'meta', # noqa: E501 + 'links': 'links', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetPosPaymentsResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data ([PosPayment]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (Meta): [optional] # noqa: E501 + links (Links): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetPosPaymentsResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data ([PosPayment]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (Meta): [optional] # noqa: E501 + links (Links): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/get_profit_and_loss_response.py b/src/apideck/model/get_profit_and_loss_response.py new file mode 100644 index 0000000000..25e085fb5b --- /dev/null +++ b/src/apideck/model/get_profit_and_loss_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.profit_and_loss import ProfitAndLoss + globals()['ProfitAndLoss'] = ProfitAndLoss + + +class GetProfitAndLossResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (ProfitAndLoss,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetProfitAndLossResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (ProfitAndLoss): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetProfitAndLossResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (ProfitAndLoss): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/get_shared_link_response.py b/src/apideck/model/get_shared_link_response.py new file mode 100644 index 0000000000..bab1b7891b --- /dev/null +++ b/src/apideck/model/get_shared_link_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.shared_link import SharedLink + globals()['SharedLink'] = SharedLink + + +class GetSharedLinkResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (SharedLink,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetSharedLinkResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (SharedLink): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetSharedLinkResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (SharedLink): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/get_shared_links_response.py b/src/apideck/model/get_shared_links_response.py new file mode 100644 index 0000000000..cab2ca9d5b --- /dev/null +++ b/src/apideck/model/get_shared_links_response.py @@ -0,0 +1,309 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.links import Links + from apideck.model.meta import Meta + from apideck.model.shared_link import SharedLink + globals()['Links'] = Links + globals()['Meta'] = Meta + globals()['SharedLink'] = SharedLink + + +class GetSharedLinksResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': ([SharedLink],), # noqa: E501 + 'meta': (Meta,), # noqa: E501 + 'links': (Links,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + 'meta': 'meta', # noqa: E501 + 'links': 'links', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetSharedLinksResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data ([SharedLink]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (Meta): [optional] # noqa: E501 + links (Links): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetSharedLinksResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data ([SharedLink]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (Meta): [optional] # noqa: E501 + links (Links): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/get_supplier_response.py b/src/apideck/model/get_supplier_response.py new file mode 100644 index 0000000000..5217ec07d8 --- /dev/null +++ b/src/apideck/model/get_supplier_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.supplier import Supplier + globals()['Supplier'] = Supplier + + +class GetSupplierResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (Supplier,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetSupplierResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (Supplier): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetSupplierResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (Supplier): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/get_suppliers_response.py b/src/apideck/model/get_suppliers_response.py new file mode 100644 index 0000000000..ed724cf019 --- /dev/null +++ b/src/apideck/model/get_suppliers_response.py @@ -0,0 +1,309 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.links import Links + from apideck.model.meta import Meta + from apideck.model.supplier import Supplier + globals()['Links'] = Links + globals()['Meta'] = Meta + globals()['Supplier'] = Supplier + + +class GetSuppliersResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': ([Supplier],), # noqa: E501 + 'meta': (Meta,), # noqa: E501 + 'links': (Links,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + 'meta': 'meta', # noqa: E501 + 'links': 'links', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetSuppliersResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data ([Supplier]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (Meta): [optional] # noqa: E501 + links (Links): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetSuppliersResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data ([Supplier]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (Meta): [optional] # noqa: E501 + links (Links): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/get_tax_rate_response.py b/src/apideck/model/get_tax_rate_response.py new file mode 100644 index 0000000000..acdfdf6753 --- /dev/null +++ b/src/apideck/model/get_tax_rate_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.tax_rate import TaxRate + globals()['TaxRate'] = TaxRate + + +class GetTaxRateResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (TaxRate,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetTaxRateResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (TaxRate): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetTaxRateResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (TaxRate): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/get_tax_rates_response.py b/src/apideck/model/get_tax_rates_response.py new file mode 100644 index 0000000000..755b32a074 --- /dev/null +++ b/src/apideck/model/get_tax_rates_response.py @@ -0,0 +1,309 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.links import Links + from apideck.model.meta import Meta + from apideck.model.tax_rate import TaxRate + globals()['Links'] = Links + globals()['Meta'] = Meta + globals()['TaxRate'] = TaxRate + + +class GetTaxRatesResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': ([TaxRate],), # noqa: E501 + 'meta': (Meta,), # noqa: E501 + 'links': (Links,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + 'meta': 'meta', # noqa: E501 + 'links': 'links', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetTaxRatesResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data ([TaxRate]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (Meta): [optional] # noqa: E501 + links (Links): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetTaxRatesResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data ([TaxRate]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (Meta): [optional] # noqa: E501 + links (Links): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/get_tender_response.py b/src/apideck/model/get_tender_response.py new file mode 100644 index 0000000000..a57062f106 --- /dev/null +++ b/src/apideck/model/get_tender_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.tender import Tender + globals()['Tender'] = Tender + + +class GetTenderResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (Tender,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetTenderResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (Tender): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetTenderResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (Tender): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/get_tenders_response.py b/src/apideck/model/get_tenders_response.py new file mode 100644 index 0000000000..0af895f848 --- /dev/null +++ b/src/apideck/model/get_tenders_response.py @@ -0,0 +1,309 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.links import Links + from apideck.model.meta import Meta + from apideck.model.tender import Tender + globals()['Links'] = Links + globals()['Meta'] = Meta + globals()['Tender'] = Tender + + +class GetTendersResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': ([Tender],), # noqa: E501 + 'meta': (Meta,), # noqa: E501 + 'links': (Links,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + 'meta': 'meta', # noqa: E501 + 'links': 'links', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetTendersResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data ([Tender]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (Meta): [optional] # noqa: E501 + links (Links): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetTendersResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data ([Tender]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (Meta): [optional] # noqa: E501 + links (Links): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/get_time_off_request_response.py b/src/apideck/model/get_time_off_request_response.py new file mode 100644 index 0000000000..caa5f84d0d --- /dev/null +++ b/src/apideck/model/get_time_off_request_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.time_off_request import TimeOffRequest + globals()['TimeOffRequest'] = TimeOffRequest + + +class GetTimeOffRequestResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (TimeOffRequest,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetTimeOffRequestResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (TimeOffRequest): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetTimeOffRequestResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (TimeOffRequest): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/get_time_off_requests_response.py b/src/apideck/model/get_time_off_requests_response.py new file mode 100644 index 0000000000..0bde80cedf --- /dev/null +++ b/src/apideck/model/get_time_off_requests_response.py @@ -0,0 +1,309 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.links import Links + from apideck.model.meta import Meta + from apideck.model.time_off_request import TimeOffRequest + globals()['Links'] = Links + globals()['Meta'] = Meta + globals()['TimeOffRequest'] = TimeOffRequest + + +class GetTimeOffRequestsResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': ([TimeOffRequest],), # noqa: E501 + 'meta': (Meta,), # noqa: E501 + 'links': (Links,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + 'meta': 'meta', # noqa: E501 + 'links': 'links', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetTimeOffRequestsResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data ([TimeOffRequest]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (Meta): [optional] # noqa: E501 + links (Links): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetTimeOffRequestsResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data ([TimeOffRequest]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (Meta): [optional] # noqa: E501 + links (Links): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/get_upload_session_response.py b/src/apideck/model/get_upload_session_response.py new file mode 100644 index 0000000000..abf1e99d95 --- /dev/null +++ b/src/apideck/model/get_upload_session_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.upload_session import UploadSession + globals()['UploadSession'] = UploadSession + + +class GetUploadSessionResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UploadSession,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetUploadSessionResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UploadSession): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetUploadSessionResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UploadSession): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/get_user_response.py b/src/apideck/model/get_user_response.py new file mode 100644 index 0000000000..27e1f54664 --- /dev/null +++ b/src/apideck/model/get_user_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.user import User + globals()['User'] = User + + +class GetUserResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (User,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetUserResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (User): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetUserResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (User): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/get_users_response.py b/src/apideck/model/get_users_response.py new file mode 100644 index 0000000000..1c7105850b --- /dev/null +++ b/src/apideck/model/get_users_response.py @@ -0,0 +1,309 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.links import Links + from apideck.model.meta import Meta + from apideck.model.user import User + globals()['Links'] = Links + globals()['Meta'] = Meta + globals()['User'] = User + + +class GetUsersResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': ([User],), # noqa: E501 + 'meta': (Meta,), # noqa: E501 + 'links': (Links,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + 'meta': 'meta', # noqa: E501 + 'links': 'links', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetUsersResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data ([User]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (Meta): [optional] # noqa: E501 + links (Links): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """GetUsersResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data ([User]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (Meta): [optional] # noqa: E501 + links (Links): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/get_webhook_event_logs_response.py b/src/apideck/model/get_webhook_event_logs_response.py new file mode 100644 index 0000000000..dad7ed3f35 --- /dev/null +++ b/src/apideck/model/get_webhook_event_logs_response.py @@ -0,0 +1,291 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.links import Links + from apideck.model.meta import Meta + from apideck.model.webhook_event_log import WebhookEventLog + globals()['Links'] = Links + globals()['Meta'] = Meta + globals()['WebhookEventLog'] = WebhookEventLog + + +class GetWebhookEventLogsResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'data': ([WebhookEventLog],), # noqa: E501 + 'meta': (Meta,), # noqa: E501 + 'links': (Links,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'data': 'data', # noqa: E501 + 'meta': 'meta', # noqa: E501 + 'links': 'links', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, data, *args, **kwargs): # noqa: E501 + """GetWebhookEventLogsResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + data ([WebhookEventLog]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (Meta): [optional] # noqa: E501 + links (Links): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, data, *args, **kwargs): # noqa: E501 + """GetWebhookEventLogsResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + data ([WebhookEventLog]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (Meta): [optional] # noqa: E501 + links (Links): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/get_webhook_response.py b/src/apideck/model/get_webhook_response.py new file mode 100644 index 0000000000..9dc6679248 --- /dev/null +++ b/src/apideck/model/get_webhook_response.py @@ -0,0 +1,279 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.webhook import Webhook + globals()['Webhook'] = Webhook + + +class GetWebhookResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'data': (Webhook,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, data, *args, **kwargs): # noqa: E501 + """GetWebhookResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + data (Webhook): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, data, *args, **kwargs): # noqa: E501 + """GetWebhookResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + data (Webhook): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/get_webhooks_response.py b/src/apideck/model/get_webhooks_response.py new file mode 100644 index 0000000000..a848c1a6e5 --- /dev/null +++ b/src/apideck/model/get_webhooks_response.py @@ -0,0 +1,291 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.links import Links + from apideck.model.meta import Meta + from apideck.model.webhook import Webhook + globals()['Links'] = Links + globals()['Meta'] = Meta + globals()['Webhook'] = Webhook + + +class GetWebhooksResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'data': ([Webhook],), # noqa: E501 + 'meta': (Meta,), # noqa: E501 + 'links': (Links,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'data': 'data', # noqa: E501 + 'meta': 'meta', # noqa: E501 + 'links': 'links', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, data, *args, **kwargs): # noqa: E501 + """GetWebhooksResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + data ([Webhook]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (Meta): [optional] # noqa: E501 + links (Links): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, data, *args, **kwargs): # noqa: E501 + """GetWebhooksResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + data ([Webhook]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + meta (Meta): [optional] # noqa: E501 + links (Links): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/hris_company.py b/src/apideck/model/hris_company.py new file mode 100644 index 0000000000..9f5f2d44e2 --- /dev/null +++ b/src/apideck/model/hris_company.py @@ -0,0 +1,350 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.address import Address + from apideck.model.email import Email + from apideck.model.phone_number import PhoneNumber + from apideck.model.website import Website + globals()['Address'] = Address + globals()['Email'] = Email + globals()['PhoneNumber'] = PhoneNumber + globals()['Website'] = Website + + +class HrisCompany(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('status',): { + 'ACTIVE': "active", + 'INACTIVE': "inactive", + 'TRIAL': "trial", + 'OTHER': "other", + }, + } + + validations = { + ('legal_name',): { + 'min_length': 1, + }, + ('display_name',): { + 'min_length': 1, + }, + ('subdomain',): { + 'min_length': 1, + }, + ('debtor_id',): { + 'min_length': 1, + }, + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'legal_name': (str,), # noqa: E501 + 'id': (str,), # noqa: E501 + 'display_name': (str,), # noqa: E501 + 'subdomain': (str,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'company_number': (str, none_type,), # noqa: E501 + 'addresses': ([Address],), # noqa: E501 + 'phone_numbers': ([PhoneNumber],), # noqa: E501 + 'emails': ([Email],), # noqa: E501 + 'websites': ([Website],), # noqa: E501 + 'debtor_id': (str,), # noqa: E501 + 'deleted': (bool,), # noqa: E501 + 'updated_by': (str, none_type,), # noqa: E501 + 'created_by': (str, none_type,), # noqa: E501 + 'updated_at': (datetime,), # noqa: E501 + 'created_at': (datetime,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'legal_name': 'legal_name', # noqa: E501 + 'id': 'id', # noqa: E501 + 'display_name': 'display_name', # noqa: E501 + 'subdomain': 'subdomain', # noqa: E501 + 'status': 'status', # noqa: E501 + 'company_number': 'company_number', # noqa: E501 + 'addresses': 'addresses', # noqa: E501 + 'phone_numbers': 'phone_numbers', # noqa: E501 + 'emails': 'emails', # noqa: E501 + 'websites': 'websites', # noqa: E501 + 'debtor_id': 'debtor_id', # noqa: E501 + 'deleted': 'deleted', # noqa: E501 + 'updated_by': 'updated_by', # noqa: E501 + 'created_by': 'created_by', # noqa: E501 + 'updated_at': 'updated_at', # noqa: E501 + 'created_at': 'created_at', # noqa: E501 + } + + read_only_vars = { + 'id', # noqa: E501 + 'deleted', # noqa: E501 + 'updated_by', # noqa: E501 + 'created_by', # noqa: E501 + 'updated_at', # noqa: E501 + 'created_at', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, legal_name, *args, **kwargs): # noqa: E501 + """HrisCompany - a model defined in OpenAPI + + Args: + legal_name (str): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + display_name (str): [optional] # noqa: E501 + subdomain (str): [optional] # noqa: E501 + status (str): [optional] # noqa: E501 + company_number (str, none_type): An Company Number, Company ID or Company Code, is a unique number that has been assigned to each company.. [optional] # noqa: E501 + addresses ([Address]): [optional] # noqa: E501 + phone_numbers ([PhoneNumber]): [optional] # noqa: E501 + emails ([Email]): [optional] # noqa: E501 + websites ([Website]): [optional] # noqa: E501 + debtor_id (str): [optional] # noqa: E501 + deleted (bool): [optional] # noqa: E501 + updated_by (str, none_type): [optional] # noqa: E501 + created_by (str, none_type): [optional] # noqa: E501 + updated_at (datetime): [optional] # noqa: E501 + created_at (datetime): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.legal_name = legal_name + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, legal_name, *args, **kwargs): # noqa: E501 + """HrisCompany - a model defined in OpenAPI + + Args: + legal_name (str): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + display_name (str): [optional] # noqa: E501 + subdomain (str): [optional] # noqa: E501 + status (str): [optional] # noqa: E501 + company_number (str, none_type): An Company Number, Company ID or Company Code, is a unique number that has been assigned to each company.. [optional] # noqa: E501 + addresses ([Address]): [optional] # noqa: E501 + phone_numbers ([PhoneNumber]): [optional] # noqa: E501 + emails ([Email]): [optional] # noqa: E501 + websites ([Website]): [optional] # noqa: E501 + debtor_id (str): [optional] # noqa: E501 + deleted (bool): [optional] # noqa: E501 + updated_by (str, none_type): [optional] # noqa: E501 + created_by (str, none_type): [optional] # noqa: E501 + updated_at (datetime): [optional] # noqa: E501 + created_at (datetime): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.legal_name = legal_name + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/hris_event_type.py b/src/apideck/model/hris_event_type.py new file mode 100644 index 0000000000..153bbc5d04 --- /dev/null +++ b/src/apideck/model/hris_event_type.py @@ -0,0 +1,287 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class HrisEventType(ModelSimple): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('value',): { + '*': "*", + 'HRIS.EMPLOYEE.CREATED': "hris.employee.created", + 'HRIS.EMPLOYEE.UPDATED': "hris.employee.updated", + 'HRIS.EMPLOYEE.DELETED': "hris.employee.deleted", + 'HRIS.COMPANY.CREATED': "hris.company.created", + 'HRIS.COMPANY.UPDATED': "hris.company.updated", + 'HRIS.COMPANY.DELETED': "hris.company.deleted", + }, + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'value': (str,), + } + + @cached_property + def discriminator(): + return None + + + attribute_map = {} + + read_only_vars = set() + + _composed_schemas = None + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): + """HrisEventType - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] (str):, must be one of ["*", "hris.employee.created", "hris.employee.updated", "hris.employee.deleted", "hris.company.created", "hris.company.updated", "hris.company.deleted", ] # noqa: E501 + + Keyword Args: + value (str):, must be one of ["*", "hris.employee.created", "hris.employee.updated", "hris.employee.deleted", "hris.company.created", "hris.company.updated", "hris.company.deleted", ] # noqa: E501 + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + self.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): + """HrisEventType - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] (str):, must be one of ["*", "hris.employee.created", "hris.employee.updated", "hris.employee.deleted", "hris.company.created", "hris.company.updated", "hris.company.deleted", ] # noqa: E501 + + Keyword Args: + value (str):, must be one of ["*", "hris.employee.created", "hris.employee.updated", "hris.employee.deleted", "hris.company.created", "hris.company.updated", "hris.company.deleted", ] # noqa: E501 + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + self.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + return self diff --git a/src/apideck/model/hris_job.py b/src/apideck/model/hris_job.py new file mode 100644 index 0000000000..8e9d90841b --- /dev/null +++ b/src/apideck/model/hris_job.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.hris_job_location import HrisJobLocation + globals()['HrisJobLocation'] = HrisJobLocation + + +class HrisJob(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('employment_status',): { + 'None': None, + 'ACTIVE': "active", + 'INACTIVE': "inactive", + 'TERMINATED': "terminated", + 'OTHER': "other", + }, + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'id': (str,), # noqa: E501 + 'employee_id': (str,), # noqa: E501 + 'title': (str, none_type,), # noqa: E501 + 'start_date': (date, none_type,), # noqa: E501 + 'end_date': (date, none_type,), # noqa: E501 + 'employment_status': (str, none_type,), # noqa: E501 + 'department': (str, none_type,), # noqa: E501 + 'location': (HrisJobLocation,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'employee_id': 'employee_id', # noqa: E501 + 'title': 'title', # noqa: E501 + 'start_date': 'start_date', # noqa: E501 + 'end_date': 'end_date', # noqa: E501 + 'employment_status': 'employment_status', # noqa: E501 + 'department': 'department', # noqa: E501 + 'location': 'location', # noqa: E501 + } + + read_only_vars = { + 'id', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """HrisJob - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + employee_id (str): Id of the employee. [optional] # noqa: E501 + title (str, none_type): [optional] # noqa: E501 + start_date (date, none_type): [optional] # noqa: E501 + end_date (date, none_type): [optional] # noqa: E501 + employment_status (str, none_type): [optional] # noqa: E501 + department (str, none_type): Department name. [optional] # noqa: E501 + location (HrisJobLocation): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """HrisJob - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + employee_id (str): Id of the employee. [optional] # noqa: E501 + title (str, none_type): [optional] # noqa: E501 + start_date (date, none_type): [optional] # noqa: E501 + end_date (date, none_type): [optional] # noqa: E501 + employment_status (str, none_type): [optional] # noqa: E501 + department (str, none_type): Department name. [optional] # noqa: E501 + location (HrisJobLocation): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/hris_job_location.py b/src/apideck/model/hris_job_location.py new file mode 100644 index 0000000000..adadea29e0 --- /dev/null +++ b/src/apideck/model/hris_job_location.py @@ -0,0 +1,255 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class HrisJobLocation(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'name': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'name': 'name', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """HrisJobLocation - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + name (str, none_type): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """HrisJobLocation - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + name (str, none_type): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/hris_jobs.py b/src/apideck/model/hris_jobs.py new file mode 100644 index 0000000000..963daaffa5 --- /dev/null +++ b/src/apideck/model/hris_jobs.py @@ -0,0 +1,267 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.employee import Employee + from apideck.model.hris_job import HrisJob + globals()['Employee'] = Employee + globals()['HrisJob'] = HrisJob + + +class HrisJobs(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'employee': (Employee,), # noqa: E501 + 'jobs': ([HrisJob],), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'employee': 'employee', # noqa: E501 + 'jobs': 'jobs', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """HrisJobs - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + employee (Employee): [optional] # noqa: E501 + jobs ([HrisJob]): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """HrisJobs - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + employee (Employee): [optional] # noqa: E501 + jobs ([HrisJob]): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/idempotency_key.py b/src/apideck/model/idempotency_key.py new file mode 100644 index 0000000000..a777fd7a3e --- /dev/null +++ b/src/apideck/model/idempotency_key.py @@ -0,0 +1,281 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class IdempotencyKey(ModelSimple): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + ('value',): { + 'max_length': 45, + }, + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'value': (str,), + } + + @cached_property + def discriminator(): + return None + + + attribute_map = {} + + read_only_vars = set() + + _composed_schemas = None + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): + """IdempotencyKey - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] (str): A value you specify that uniquely identifies this request among requests you have sent.. # noqa: E501 + + Keyword Args: + value (str): A value you specify that uniquely identifies this request among requests you have sent.. # noqa: E501 + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + self.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): + """IdempotencyKey - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] (str): A value you specify that uniquely identifies this request among requests you have sent.. # noqa: E501 + + Keyword Args: + value (str): A value you specify that uniquely identifies this request among requests you have sent.. # noqa: E501 + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + self.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + return self diff --git a/src/apideck/model/invoice.py b/src/apideck/model/invoice.py new file mode 100644 index 0000000000..92f27536f9 --- /dev/null +++ b/src/apideck/model/invoice.py @@ -0,0 +1,414 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.address import Address + from apideck.model.currency import Currency + from apideck.model.invoice_line_item import InvoiceLineItem + from apideck.model.linked_customer import LinkedCustomer + globals()['Address'] = Address + globals()['Currency'] = Currency + globals()['InvoiceLineItem'] = InvoiceLineItem + globals()['LinkedCustomer'] = LinkedCustomer + + +class Invoice(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('type',): { + 'None': None, + 'STANDARD': "standard", + 'CREDIT': "credit", + 'SERVICE': "service", + 'PRODUCT': "product", + 'SUPPLIER': "supplier", + 'OTHER': "other", + }, + ('status',): { + 'None': None, + 'DRAFT': "draft", + 'SUBMITTED': "submitted", + 'AUTHORISED': "authorised", + 'PARTIALLY_PAID': "partially_paid", + 'PAID': "paid", + 'VOID': "void", + 'CREDIT': "credit", + 'DELETED': "deleted", + }, + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'id': (str,), # noqa: E501 + 'downstream_id': (str, none_type,), # noqa: E501 + 'type': (str, none_type,), # noqa: E501 + 'number': (str, none_type,), # noqa: E501 + 'customer': (LinkedCustomer,), # noqa: E501 + 'invoice_date': (date, none_type,), # noqa: E501 + 'due_date': (date, none_type,), # noqa: E501 + 'terms': (str, none_type,), # noqa: E501 + 'po_number': (str, none_type,), # noqa: E501 + 'reference': (str, none_type,), # noqa: E501 + 'status': (str, none_type,), # noqa: E501 + 'invoice_sent': (bool,), # noqa: E501 + 'currency': (Currency,), # noqa: E501 + 'currency_rate': (float, none_type,), # noqa: E501 + 'tax_inclusive': (bool, none_type,), # noqa: E501 + 'sub_total': (float, none_type,), # noqa: E501 + 'total_tax': (float, none_type,), # noqa: E501 + 'tax_code': (str, none_type,), # noqa: E501 + 'discount_percentage': (float, none_type,), # noqa: E501 + 'total': (float, none_type,), # noqa: E501 + 'balance': (float, none_type,), # noqa: E501 + 'deposit': (float, none_type,), # noqa: E501 + 'customer_memo': (str, none_type,), # noqa: E501 + 'line_items': ([InvoiceLineItem],), # noqa: E501 + 'billing_address': (Address,), # noqa: E501 + 'shipping_address': (Address,), # noqa: E501 + 'template_id': (str, none_type,), # noqa: E501 + 'source_document_url': (str, none_type,), # noqa: E501 + 'row_version': (str, none_type,), # noqa: E501 + 'updated_by': (str, none_type,), # noqa: E501 + 'created_by': (str, none_type,), # noqa: E501 + 'updated_at': (datetime,), # noqa: E501 + 'created_at': (datetime,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'downstream_id': 'downstream_id', # noqa: E501 + 'type': 'type', # noqa: E501 + 'number': 'number', # noqa: E501 + 'customer': 'customer', # noqa: E501 + 'invoice_date': 'invoice_date', # noqa: E501 + 'due_date': 'due_date', # noqa: E501 + 'terms': 'terms', # noqa: E501 + 'po_number': 'po_number', # noqa: E501 + 'reference': 'reference', # noqa: E501 + 'status': 'status', # noqa: E501 + 'invoice_sent': 'invoice_sent', # noqa: E501 + 'currency': 'currency', # noqa: E501 + 'currency_rate': 'currency_rate', # noqa: E501 + 'tax_inclusive': 'tax_inclusive', # noqa: E501 + 'sub_total': 'sub_total', # noqa: E501 + 'total_tax': 'total_tax', # noqa: E501 + 'tax_code': 'tax_code', # noqa: E501 + 'discount_percentage': 'discount_percentage', # noqa: E501 + 'total': 'total', # noqa: E501 + 'balance': 'balance', # noqa: E501 + 'deposit': 'deposit', # noqa: E501 + 'customer_memo': 'customer_memo', # noqa: E501 + 'line_items': 'line_items', # noqa: E501 + 'billing_address': 'billing_address', # noqa: E501 + 'shipping_address': 'shipping_address', # noqa: E501 + 'template_id': 'template_id', # noqa: E501 + 'source_document_url': 'source_document_url', # noqa: E501 + 'row_version': 'row_version', # noqa: E501 + 'updated_by': 'updated_by', # noqa: E501 + 'created_by': 'created_by', # noqa: E501 + 'updated_at': 'updated_at', # noqa: E501 + 'created_at': 'created_at', # noqa: E501 + } + + read_only_vars = { + 'id', # noqa: E501 + 'downstream_id', # noqa: E501 + 'updated_by', # noqa: E501 + 'created_by', # noqa: E501 + 'updated_at', # noqa: E501 + 'created_at', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """Invoice - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + downstream_id (str, none_type): The third-party API ID of original entity. [optional] # noqa: E501 + type (str, none_type): Invoice type. [optional] # noqa: E501 + number (str, none_type): Invoice number.. [optional] # noqa: E501 + customer (LinkedCustomer): [optional] # noqa: E501 + invoice_date (date, none_type): Date invoice was issued - YYYY-MM-DD.. [optional] # noqa: E501 + due_date (date, none_type): The invoice due date is the date on which a payment or invoice is scheduled to be received by the seller - YYYY-MM-DD.. [optional] # noqa: E501 + terms (str, none_type): Terms of payment.. [optional] # noqa: E501 + po_number (str, none_type): A PO Number uniquely identifies a purchase order and is generally defined by the buyer. The buyer will match the PO number in the invoice to the Purchase Order.. [optional] # noqa: E501 + reference (str, none_type): Optional invoice reference.. [optional] # noqa: E501 + status (str, none_type): Invoice status. [optional] # noqa: E501 + invoice_sent (bool): Invoice sent to contact/customer.. [optional] # noqa: E501 + currency (Currency): [optional] # noqa: E501 + currency_rate (float, none_type): Currency Exchange Rate at the time entity was recorded/generated.. [optional] # noqa: E501 + tax_inclusive (bool, none_type): Amounts are including tax. [optional] # noqa: E501 + sub_total (float, none_type): Sub-total amount, normally before tax.. [optional] # noqa: E501 + total_tax (float, none_type): Total tax amount applied to this invoice.. [optional] # noqa: E501 + tax_code (str, none_type): Applicable tax id/code override if tax is not supplied on a line item basis.. [optional] # noqa: E501 + discount_percentage (float, none_type): Discount percentage applied to this invoice.. [optional] # noqa: E501 + total (float, none_type): Total amount of invoice, including tax.. [optional] # noqa: E501 + balance (float, none_type): Balance of invoice due.. [optional] # noqa: E501 + deposit (float, none_type): Amount of deposit made to this invoice.. [optional] # noqa: E501 + customer_memo (str, none_type): Customer memo. [optional] # noqa: E501 + line_items ([InvoiceLineItem]): [optional] # noqa: E501 + billing_address (Address): [optional] # noqa: E501 + shipping_address (Address): [optional] # noqa: E501 + template_id (str, none_type): Optional invoice template. [optional] # noqa: E501 + source_document_url (str, none_type): URL link to a source document - shown as 'Go to [appName]' in the downstream app. Currently only supported for Xero.. [optional] # noqa: E501 + row_version (str, none_type): [optional] # noqa: E501 + updated_by (str, none_type): [optional] # noqa: E501 + created_by (str, none_type): [optional] # noqa: E501 + updated_at (datetime): [optional] # noqa: E501 + created_at (datetime): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """Invoice - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + downstream_id (str, none_type): The third-party API ID of original entity. [optional] # noqa: E501 + type (str, none_type): Invoice type. [optional] # noqa: E501 + number (str, none_type): Invoice number.. [optional] # noqa: E501 + customer (LinkedCustomer): [optional] # noqa: E501 + invoice_date (date, none_type): Date invoice was issued - YYYY-MM-DD.. [optional] # noqa: E501 + due_date (date, none_type): The invoice due date is the date on which a payment or invoice is scheduled to be received by the seller - YYYY-MM-DD.. [optional] # noqa: E501 + terms (str, none_type): Terms of payment.. [optional] # noqa: E501 + po_number (str, none_type): A PO Number uniquely identifies a purchase order and is generally defined by the buyer. The buyer will match the PO number in the invoice to the Purchase Order.. [optional] # noqa: E501 + reference (str, none_type): Optional invoice reference.. [optional] # noqa: E501 + status (str, none_type): Invoice status. [optional] # noqa: E501 + invoice_sent (bool): Invoice sent to contact/customer.. [optional] # noqa: E501 + currency (Currency): [optional] # noqa: E501 + currency_rate (float, none_type): Currency Exchange Rate at the time entity was recorded/generated.. [optional] # noqa: E501 + tax_inclusive (bool, none_type): Amounts are including tax. [optional] # noqa: E501 + sub_total (float, none_type): Sub-total amount, normally before tax.. [optional] # noqa: E501 + total_tax (float, none_type): Total tax amount applied to this invoice.. [optional] # noqa: E501 + tax_code (str, none_type): Applicable tax id/code override if tax is not supplied on a line item basis.. [optional] # noqa: E501 + discount_percentage (float, none_type): Discount percentage applied to this invoice.. [optional] # noqa: E501 + total (float, none_type): Total amount of invoice, including tax.. [optional] # noqa: E501 + balance (float, none_type): Balance of invoice due.. [optional] # noqa: E501 + deposit (float, none_type): Amount of deposit made to this invoice.. [optional] # noqa: E501 + customer_memo (str, none_type): Customer memo. [optional] # noqa: E501 + line_items ([InvoiceLineItem]): [optional] # noqa: E501 + billing_address (Address): [optional] # noqa: E501 + shipping_address (Address): [optional] # noqa: E501 + template_id (str, none_type): Optional invoice template. [optional] # noqa: E501 + source_document_url (str, none_type): URL link to a source document - shown as 'Go to [appName]' in the downstream app. Currently only supported for Xero.. [optional] # noqa: E501 + row_version (str, none_type): [optional] # noqa: E501 + updated_by (str, none_type): [optional] # noqa: E501 + created_by (str, none_type): [optional] # noqa: E501 + updated_at (datetime): [optional] # noqa: E501 + created_at (datetime): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/invoice_item.py b/src/apideck/model/invoice_item.py new file mode 100644 index 0000000000..be12be7c1b --- /dev/null +++ b/src/apideck/model/invoice_item.py @@ -0,0 +1,351 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.invoice_item_sales_details import InvoiceItemSalesDetails + from apideck.model.linked_ledger_account import LinkedLedgerAccount + globals()['InvoiceItemSalesDetails'] = InvoiceItemSalesDetails + globals()['LinkedLedgerAccount'] = LinkedLedgerAccount + + +class InvoiceItem(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('type',): { + 'None': None, + 'INVENTORY': "inventory", + 'SERVICE': "service", + 'OTHER': "other", + }, + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'id': (str,), # noqa: E501 + 'name': (str, none_type,), # noqa: E501 + 'description': (str, none_type,), # noqa: E501 + 'code': (str, none_type,), # noqa: E501 + 'sold': (bool, none_type,), # noqa: E501 + 'purchased': (bool, none_type,), # noqa: E501 + 'tracked': (bool, none_type,), # noqa: E501 + 'inventory_date': (date, none_type,), # noqa: E501 + 'type': (str, none_type,), # noqa: E501 + 'sales_details': (InvoiceItemSalesDetails,), # noqa: E501 + 'purchase_details': (InvoiceItemSalesDetails,), # noqa: E501 + 'quantity': (float, none_type,), # noqa: E501 + 'unit_price': (float, none_type,), # noqa: E501 + 'asset_account': (LinkedLedgerAccount,), # noqa: E501 + 'income_account': (LinkedLedgerAccount,), # noqa: E501 + 'expense_account': (LinkedLedgerAccount,), # noqa: E501 + 'active': (bool, none_type,), # noqa: E501 + 'row_version': (str, none_type,), # noqa: E501 + 'updated_by': (str, none_type,), # noqa: E501 + 'created_by': (str, none_type,), # noqa: E501 + 'updated_at': (datetime,), # noqa: E501 + 'created_at': (datetime,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'name': 'name', # noqa: E501 + 'description': 'description', # noqa: E501 + 'code': 'code', # noqa: E501 + 'sold': 'sold', # noqa: E501 + 'purchased': 'purchased', # noqa: E501 + 'tracked': 'tracked', # noqa: E501 + 'inventory_date': 'inventory_date', # noqa: E501 + 'type': 'type', # noqa: E501 + 'sales_details': 'sales_details', # noqa: E501 + 'purchase_details': 'purchase_details', # noqa: E501 + 'quantity': 'quantity', # noqa: E501 + 'unit_price': 'unit_price', # noqa: E501 + 'asset_account': 'asset_account', # noqa: E501 + 'income_account': 'income_account', # noqa: E501 + 'expense_account': 'expense_account', # noqa: E501 + 'active': 'active', # noqa: E501 + 'row_version': 'row_version', # noqa: E501 + 'updated_by': 'updated_by', # noqa: E501 + 'created_by': 'created_by', # noqa: E501 + 'updated_at': 'updated_at', # noqa: E501 + 'created_at': 'created_at', # noqa: E501 + } + + read_only_vars = { + 'id', # noqa: E501 + 'updated_by', # noqa: E501 + 'created_by', # noqa: E501 + 'updated_at', # noqa: E501 + 'created_at', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """InvoiceItem - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): The ID of the item.. [optional] # noqa: E501 + name (str, none_type): Item name. [optional] # noqa: E501 + description (str, none_type): A short description of the item. [optional] # noqa: E501 + code (str, none_type): User defined item code. [optional] # noqa: E501 + sold (bool, none_type): Item will be available on sales transactions. [optional] # noqa: E501 + purchased (bool, none_type): Item is available for purchase transactions. [optional] # noqa: E501 + tracked (bool, none_type): Item is inventoried. [optional] # noqa: E501 + inventory_date (date, none_type): The date of opening balance if inventory item is tracked - YYYY-MM-DD.. [optional] # noqa: E501 + type (str, none_type): Item type. [optional] # noqa: E501 + sales_details (InvoiceItemSalesDetails): [optional] # noqa: E501 + purchase_details (InvoiceItemSalesDetails): [optional] # noqa: E501 + quantity (float, none_type): [optional] # noqa: E501 + unit_price (float, none_type): [optional] # noqa: E501 + asset_account (LinkedLedgerAccount): [optional] # noqa: E501 + income_account (LinkedLedgerAccount): [optional] # noqa: E501 + expense_account (LinkedLedgerAccount): [optional] # noqa: E501 + active (bool, none_type): [optional] # noqa: E501 + row_version (str, none_type): [optional] # noqa: E501 + updated_by (str, none_type): [optional] # noqa: E501 + created_by (str, none_type): [optional] # noqa: E501 + updated_at (datetime): [optional] # noqa: E501 + created_at (datetime): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """InvoiceItem - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): The ID of the item.. [optional] # noqa: E501 + name (str, none_type): Item name. [optional] # noqa: E501 + description (str, none_type): A short description of the item. [optional] # noqa: E501 + code (str, none_type): User defined item code. [optional] # noqa: E501 + sold (bool, none_type): Item will be available on sales transactions. [optional] # noqa: E501 + purchased (bool, none_type): Item is available for purchase transactions. [optional] # noqa: E501 + tracked (bool, none_type): Item is inventoried. [optional] # noqa: E501 + inventory_date (date, none_type): The date of opening balance if inventory item is tracked - YYYY-MM-DD.. [optional] # noqa: E501 + type (str, none_type): Item type. [optional] # noqa: E501 + sales_details (InvoiceItemSalesDetails): [optional] # noqa: E501 + purchase_details (InvoiceItemSalesDetails): [optional] # noqa: E501 + quantity (float, none_type): [optional] # noqa: E501 + unit_price (float, none_type): [optional] # noqa: E501 + asset_account (LinkedLedgerAccount): [optional] # noqa: E501 + income_account (LinkedLedgerAccount): [optional] # noqa: E501 + expense_account (LinkedLedgerAccount): [optional] # noqa: E501 + active (bool, none_type): [optional] # noqa: E501 + row_version (str, none_type): [optional] # noqa: E501 + updated_by (str, none_type): [optional] # noqa: E501 + created_by (str, none_type): [optional] # noqa: E501 + updated_at (datetime): [optional] # noqa: E501 + created_at (datetime): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/invoice_item_asset_account.py b/src/apideck/model/invoice_item_asset_account.py new file mode 100644 index 0000000000..eba9f1fdd8 --- /dev/null +++ b/src/apideck/model/invoice_item_asset_account.py @@ -0,0 +1,278 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class InvoiceItemAssetAccount(ModelSimple): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'value': (LinkedLedgerAccount,), + } + + @cached_property + def discriminator(): + return None + + + attribute_map = {} + + read_only_vars = set() + + _composed_schemas = None + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): + """InvoiceItemAssetAccount - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] (LinkedLedgerAccount): # noqa: E501 + + Keyword Args: + value (LinkedLedgerAccount): # noqa: E501 + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + self.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): + """InvoiceItemAssetAccount - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] (LinkedLedgerAccount): # noqa: E501 + + Keyword Args: + value (LinkedLedgerAccount): # noqa: E501 + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + self.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + return self diff --git a/src/apideck/model/invoice_item_expense_account.py b/src/apideck/model/invoice_item_expense_account.py new file mode 100644 index 0000000000..41574218dd --- /dev/null +++ b/src/apideck/model/invoice_item_expense_account.py @@ -0,0 +1,278 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class InvoiceItemExpenseAccount(ModelSimple): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'value': (LinkedLedgerAccount,), + } + + @cached_property + def discriminator(): + return None + + + attribute_map = {} + + read_only_vars = set() + + _composed_schemas = None + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): + """InvoiceItemExpenseAccount - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] (LinkedLedgerAccount): # noqa: E501 + + Keyword Args: + value (LinkedLedgerAccount): # noqa: E501 + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + self.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): + """InvoiceItemExpenseAccount - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] (LinkedLedgerAccount): # noqa: E501 + + Keyword Args: + value (LinkedLedgerAccount): # noqa: E501 + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + self.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + return self diff --git a/src/apideck/model/invoice_item_income_account.py b/src/apideck/model/invoice_item_income_account.py new file mode 100644 index 0000000000..efe49e5ca8 --- /dev/null +++ b/src/apideck/model/invoice_item_income_account.py @@ -0,0 +1,278 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class InvoiceItemIncomeAccount(ModelSimple): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'value': (LinkedLedgerAccount,), + } + + @cached_property + def discriminator(): + return None + + + attribute_map = {} + + read_only_vars = set() + + _composed_schemas = None + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): + """InvoiceItemIncomeAccount - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] (LinkedLedgerAccount): # noqa: E501 + + Keyword Args: + value (LinkedLedgerAccount): # noqa: E501 + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + self.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): + """InvoiceItemIncomeAccount - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] (LinkedLedgerAccount): # noqa: E501 + + Keyword Args: + value (LinkedLedgerAccount): # noqa: E501 + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + self.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + return self diff --git a/src/apideck/model/invoice_item_sales_details.py b/src/apideck/model/invoice_item_sales_details.py new file mode 100644 index 0000000000..a0ea3b44dc --- /dev/null +++ b/src/apideck/model/invoice_item_sales_details.py @@ -0,0 +1,273 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.linked_tax_rate import LinkedTaxRate + globals()['LinkedTaxRate'] = LinkedTaxRate + + +class InvoiceItemSalesDetails(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'unit_price': (float, none_type,), # noqa: E501 + 'unit_of_measure': (str, none_type,), # noqa: E501 + 'tax_inclusive': (bool, none_type,), # noqa: E501 + 'tax_rate': (LinkedTaxRate,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'unit_price': 'unit_price', # noqa: E501 + 'unit_of_measure': 'unit_of_measure', # noqa: E501 + 'tax_inclusive': 'tax_inclusive', # noqa: E501 + 'tax_rate': 'tax_rate', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """InvoiceItemSalesDetails - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + unit_price (float, none_type): [optional] # noqa: E501 + unit_of_measure (str, none_type): Description of the unit type the item is sold as, ie: kg, hour.. [optional] # noqa: E501 + tax_inclusive (bool, none_type): Amounts are including tax. [optional] # noqa: E501 + tax_rate (LinkedTaxRate): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """InvoiceItemSalesDetails - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + unit_price (float, none_type): [optional] # noqa: E501 + unit_of_measure (str, none_type): Description of the unit type the item is sold as, ie: kg, hour.. [optional] # noqa: E501 + tax_inclusive (bool, none_type): Amounts are including tax. [optional] # noqa: E501 + tax_rate (LinkedTaxRate): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/invoice_items_filter.py b/src/apideck/model/invoice_items_filter.py new file mode 100644 index 0000000000..079642580c --- /dev/null +++ b/src/apideck/model/invoice_items_filter.py @@ -0,0 +1,249 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class InvoiceItemsFilter(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'name': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'name': 'name', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """InvoiceItemsFilter - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + name (str): Name of Invoice Items to search for. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """InvoiceItemsFilter - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + name (str): Name of Invoice Items to search for. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/invoice_line_item.py b/src/apideck/model/invoice_line_item.py new file mode 100644 index 0000000000..d3c66596fc --- /dev/null +++ b/src/apideck/model/invoice_line_item.py @@ -0,0 +1,354 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.linked_invoice_item import LinkedInvoiceItem + from apideck.model.linked_ledger_account import LinkedLedgerAccount + from apideck.model.linked_tax_rate import LinkedTaxRate + globals()['LinkedInvoiceItem'] = LinkedInvoiceItem + globals()['LinkedLedgerAccount'] = LinkedLedgerAccount + globals()['LinkedTaxRate'] = LinkedTaxRate + + +class InvoiceLineItem(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('type',): { + 'None': None, + 'SALES_ITEM': "sales_item", + 'DISCOUNT': "discount", + 'INFO': "info", + 'SUB_TOTAL': "sub_total", + }, + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'id': (str,), # noqa: E501 + 'row_id': (str,), # noqa: E501 + 'code': (str, none_type,), # noqa: E501 + 'line_number': (int, none_type,), # noqa: E501 + 'description': (str, none_type,), # noqa: E501 + 'type': (str, none_type,), # noqa: E501 + 'tax_amount': (float, none_type,), # noqa: E501 + 'total_amount': (float, none_type,), # noqa: E501 + 'quantity': (float, none_type,), # noqa: E501 + 'unit_price': (float, none_type,), # noqa: E501 + 'unit_of_measure': (str, none_type,), # noqa: E501 + 'discount_percentage': (float, none_type,), # noqa: E501 + 'location_id': (str, none_type,), # noqa: E501 + 'department_id': (str, none_type,), # noqa: E501 + 'item': (LinkedInvoiceItem,), # noqa: E501 + 'tax_rate': (LinkedTaxRate,), # noqa: E501 + 'ledger_account': (LinkedLedgerAccount,), # noqa: E501 + 'row_version': (str, none_type,), # noqa: E501 + 'updated_by': (str, none_type,), # noqa: E501 + 'created_by': (str, none_type,), # noqa: E501 + 'created_at': (datetime,), # noqa: E501 + 'updated_at': (datetime,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'row_id': 'row_id', # noqa: E501 + 'code': 'code', # noqa: E501 + 'line_number': 'line_number', # noqa: E501 + 'description': 'description', # noqa: E501 + 'type': 'type', # noqa: E501 + 'tax_amount': 'tax_amount', # noqa: E501 + 'total_amount': 'total_amount', # noqa: E501 + 'quantity': 'quantity', # noqa: E501 + 'unit_price': 'unit_price', # noqa: E501 + 'unit_of_measure': 'unit_of_measure', # noqa: E501 + 'discount_percentage': 'discount_percentage', # noqa: E501 + 'location_id': 'location_id', # noqa: E501 + 'department_id': 'department_id', # noqa: E501 + 'item': 'item', # noqa: E501 + 'tax_rate': 'tax_rate', # noqa: E501 + 'ledger_account': 'ledger_account', # noqa: E501 + 'row_version': 'row_version', # noqa: E501 + 'updated_by': 'updated_by', # noqa: E501 + 'created_by': 'created_by', # noqa: E501 + 'created_at': 'created_at', # noqa: E501 + 'updated_at': 'updated_at', # noqa: E501 + } + + read_only_vars = { + 'id', # noqa: E501 + 'updated_by', # noqa: E501 + 'created_by', # noqa: E501 + 'created_at', # noqa: E501 + 'updated_at', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """InvoiceLineItem - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + row_id (str): Row ID. [optional] # noqa: E501 + code (str, none_type): User defined item code. [optional] # noqa: E501 + line_number (int, none_type): Line number in the invoice. [optional] # noqa: E501 + description (str, none_type): User defined description. [optional] # noqa: E501 + type (str, none_type): Item type. [optional] # noqa: E501 + tax_amount (float, none_type): Tax amount. [optional] # noqa: E501 + total_amount (float, none_type): Total amount of the line item. [optional] # noqa: E501 + quantity (float, none_type): [optional] # noqa: E501 + unit_price (float, none_type): [optional] # noqa: E501 + unit_of_measure (str, none_type): Description of the unit type the item is sold as, ie: kg, hour.. [optional] # noqa: E501 + discount_percentage (float, none_type): Discount percentage applied to the line item when supported downstream.. [optional] # noqa: E501 + location_id (str, none_type): Location id. [optional] # noqa: E501 + department_id (str, none_type): Department id. [optional] # noqa: E501 + item (LinkedInvoiceItem): [optional] # noqa: E501 + tax_rate (LinkedTaxRate): [optional] # noqa: E501 + ledger_account (LinkedLedgerAccount): [optional] # noqa: E501 + row_version (str, none_type): [optional] # noqa: E501 + updated_by (str, none_type): [optional] # noqa: E501 + created_by (str, none_type): [optional] # noqa: E501 + created_at (datetime): [optional] # noqa: E501 + updated_at (datetime): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """InvoiceLineItem - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + row_id (str): Row ID. [optional] # noqa: E501 + code (str, none_type): User defined item code. [optional] # noqa: E501 + line_number (int, none_type): Line number in the invoice. [optional] # noqa: E501 + description (str, none_type): User defined description. [optional] # noqa: E501 + type (str, none_type): Item type. [optional] # noqa: E501 + tax_amount (float, none_type): Tax amount. [optional] # noqa: E501 + total_amount (float, none_type): Total amount of the line item. [optional] # noqa: E501 + quantity (float, none_type): [optional] # noqa: E501 + unit_price (float, none_type): [optional] # noqa: E501 + unit_of_measure (str, none_type): Description of the unit type the item is sold as, ie: kg, hour.. [optional] # noqa: E501 + discount_percentage (float, none_type): Discount percentage applied to the line item when supported downstream.. [optional] # noqa: E501 + location_id (str, none_type): Location id. [optional] # noqa: E501 + department_id (str, none_type): Department id. [optional] # noqa: E501 + item (LinkedInvoiceItem): [optional] # noqa: E501 + tax_rate (LinkedTaxRate): [optional] # noqa: E501 + ledger_account (LinkedLedgerAccount): [optional] # noqa: E501 + row_version (str, none_type): [optional] # noqa: E501 + updated_by (str, none_type): [optional] # noqa: E501 + created_by (str, none_type): [optional] # noqa: E501 + created_at (datetime): [optional] # noqa: E501 + updated_at (datetime): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/invoice_response.py b/src/apideck/model/invoice_response.py new file mode 100644 index 0000000000..9246c186e2 --- /dev/null +++ b/src/apideck/model/invoice_response.py @@ -0,0 +1,261 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class InvoiceResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'id': (str,), # noqa: E501 + 'downstream_id': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'downstream_id': 'downstream_id', # noqa: E501 + } + + read_only_vars = { + 'id', # noqa: E501 + 'downstream_id', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """InvoiceResponse - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + downstream_id (str, none_type): The third-party API ID of original entity. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """InvoiceResponse - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + downstream_id (str, none_type): The third-party API ID of original entity. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/invoices_sort.py b/src/apideck/model/invoices_sort.py new file mode 100644 index 0000000000..713047bc8d --- /dev/null +++ b/src/apideck/model/invoices_sort.py @@ -0,0 +1,261 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.sort_direction import SortDirection + globals()['SortDirection'] = SortDirection + + +class InvoicesSort(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('by',): { + 'UPDATED_AT': "updated_at", + }, + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'by': (str,), # noqa: E501 + 'direction': (SortDirection,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'by': 'by', # noqa: E501 + 'direction': 'direction', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """InvoicesSort - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + by (str): The field on which to sort the Invoices. [optional] if omitted the server will use the default value of "updated_at" # noqa: E501 + direction (SortDirection): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """InvoicesSort - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + by (str): The field on which to sort the Invoices. [optional] if omitted the server will use the default value of "updated_at" # noqa: E501 + direction (SortDirection): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/item.py b/src/apideck/model/item.py new file mode 100644 index 0000000000..aa141b508c --- /dev/null +++ b/src/apideck/model/item.py @@ -0,0 +1,389 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.currency import Currency + from apideck.model.idempotency_key import IdempotencyKey + globals()['Currency'] = Currency + globals()['IdempotencyKey'] = IdempotencyKey + + +class Item(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('product_type',): { + 'REGULAR': "regular", + 'OTHER': "other", + }, + ('pricing_type',): { + 'FIXED': "fixed", + 'VARIABLE': "variable", + 'PER_UNIT': "per_unit", + 'OTHER': "other", + }, + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'name': (str,), # noqa: E501 + 'id': (str,), # noqa: E501 + 'idempotency_key': (IdempotencyKey,), # noqa: E501 + 'description': (str,), # noqa: E501 + 'abbreviation': (str,), # noqa: E501 + 'product_type': (str,), # noqa: E501 + 'price_amount': (float,), # noqa: E501 + 'pricing_type': (str,), # noqa: E501 + 'price_currency': (Currency,), # noqa: E501 + 'cost': (float,), # noqa: E501 + 'tax_ids': ([str],), # noqa: E501 + 'absent_at_location_ids': ([str],), # noqa: E501 + 'present_at_all_locations': (bool,), # noqa: E501 + 'available_for_pickup': (bool,), # noqa: E501 + 'available_online': (bool,), # noqa: E501 + 'sku': (str,), # noqa: E501 + 'code': (str,), # noqa: E501 + 'categories': ([bool, date, datetime, dict, float, int, list, str, none_type],), # noqa: E501 + 'options': ([bool, date, datetime, dict, float, int, list, str, none_type],), # noqa: E501 + 'variations': ([bool, date, datetime, dict, float, int, list, str, none_type],), # noqa: E501 + 'modifier_groups': ([bool, date, datetime, dict, float, int, list, str, none_type],), # noqa: E501 + 'available': (bool, none_type,), # noqa: E501 + 'hidden': (bool, none_type,), # noqa: E501 + 'version': (str, none_type,), # noqa: E501 + 'deleted': (bool, none_type,), # noqa: E501 + 'updated_by': (str, none_type,), # noqa: E501 + 'created_by': (str, none_type,), # noqa: E501 + 'updated_at': (datetime,), # noqa: E501 + 'created_at': (datetime,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'name': 'name', # noqa: E501 + 'id': 'id', # noqa: E501 + 'idempotency_key': 'idempotency_key', # noqa: E501 + 'description': 'description', # noqa: E501 + 'abbreviation': 'abbreviation', # noqa: E501 + 'product_type': 'product_type', # noqa: E501 + 'price_amount': 'price_amount', # noqa: E501 + 'pricing_type': 'pricing_type', # noqa: E501 + 'price_currency': 'price_currency', # noqa: E501 + 'cost': 'cost', # noqa: E501 + 'tax_ids': 'tax_ids', # noqa: E501 + 'absent_at_location_ids': 'absent_at_location_ids', # noqa: E501 + 'present_at_all_locations': 'present_at_all_locations', # noqa: E501 + 'available_for_pickup': 'available_for_pickup', # noqa: E501 + 'available_online': 'available_online', # noqa: E501 + 'sku': 'sku', # noqa: E501 + 'code': 'code', # noqa: E501 + 'categories': 'categories', # noqa: E501 + 'options': 'options', # noqa: E501 + 'variations': 'variations', # noqa: E501 + 'modifier_groups': 'modifier_groups', # noqa: E501 + 'available': 'available', # noqa: E501 + 'hidden': 'hidden', # noqa: E501 + 'version': 'version', # noqa: E501 + 'deleted': 'deleted', # noqa: E501 + 'updated_by': 'updated_by', # noqa: E501 + 'created_by': 'created_by', # noqa: E501 + 'updated_at': 'updated_at', # noqa: E501 + 'created_at': 'created_at', # noqa: E501 + } + + read_only_vars = { + 'version', # noqa: E501 + 'updated_by', # noqa: E501 + 'created_by', # noqa: E501 + 'updated_at', # noqa: E501 + 'created_at', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, name, *args, **kwargs): # noqa: E501 + """Item - a model defined in OpenAPI + + Args: + name (str): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + idempotency_key (IdempotencyKey): [optional] # noqa: E501 + description (str): [optional] # noqa: E501 + abbreviation (str): [optional] # noqa: E501 + product_type (str): [optional] # noqa: E501 + price_amount (float): [optional] # noqa: E501 + pricing_type (str): [optional] # noqa: E501 + price_currency (Currency): [optional] # noqa: E501 + cost (float): [optional] # noqa: E501 + tax_ids ([str]): A list of Tax IDs for the product.. [optional] # noqa: E501 + absent_at_location_ids ([str]): A list of locations where the object is not present, even if present_at_all_locations is true. This can include locations that are deactivated.. [optional] # noqa: E501 + present_at_all_locations (bool): [optional] # noqa: E501 + available_for_pickup (bool): [optional] # noqa: E501 + available_online (bool): [optional] # noqa: E501 + sku (str): SKU of the item. [optional] # noqa: E501 + code (str): Product code, e.g. UPC or EAN. [optional] # noqa: E501 + categories ([bool, date, datetime, dict, float, int, list, str, none_type]): [optional] # noqa: E501 + options ([bool, date, datetime, dict, float, int, list, str, none_type]): List of options pertaining to this item's attribute variation. [optional] # noqa: E501 + variations ([bool, date, datetime, dict, float, int, list, str, none_type]): [optional] # noqa: E501 + modifier_groups ([bool, date, datetime, dict, float, int, list, str, none_type]): [optional] # noqa: E501 + available (bool, none_type): [optional] # noqa: E501 + hidden (bool, none_type): [optional] # noqa: E501 + version (str, none_type): [optional] # noqa: E501 + deleted (bool, none_type): [optional] # noqa: E501 + updated_by (str, none_type): [optional] # noqa: E501 + created_by (str, none_type): [optional] # noqa: E501 + updated_at (datetime): [optional] # noqa: E501 + created_at (datetime): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.name = name + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, name, *args, **kwargs): # noqa: E501 + """Item - a model defined in OpenAPI + + Args: + name (str): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + idempotency_key (IdempotencyKey): [optional] # noqa: E501 + description (str): [optional] # noqa: E501 + abbreviation (str): [optional] # noqa: E501 + product_type (str): [optional] # noqa: E501 + price_amount (float): [optional] # noqa: E501 + pricing_type (str): [optional] # noqa: E501 + price_currency (Currency): [optional] # noqa: E501 + cost (float): [optional] # noqa: E501 + tax_ids ([str]): A list of Tax IDs for the product.. [optional] # noqa: E501 + absent_at_location_ids ([str]): A list of locations where the object is not present, even if present_at_all_locations is true. This can include locations that are deactivated.. [optional] # noqa: E501 + present_at_all_locations (bool): [optional] # noqa: E501 + available_for_pickup (bool): [optional] # noqa: E501 + available_online (bool): [optional] # noqa: E501 + sku (str): SKU of the item. [optional] # noqa: E501 + code (str): Product code, e.g. UPC or EAN. [optional] # noqa: E501 + categories ([bool, date, datetime, dict, float, int, list, str, none_type]): [optional] # noqa: E501 + options ([bool, date, datetime, dict, float, int, list, str, none_type]): List of options pertaining to this item's attribute variation. [optional] # noqa: E501 + variations ([bool, date, datetime, dict, float, int, list, str, none_type]): [optional] # noqa: E501 + modifier_groups ([bool, date, datetime, dict, float, int, list, str, none_type]): [optional] # noqa: E501 + available (bool, none_type): [optional] # noqa: E501 + hidden (bool, none_type): [optional] # noqa: E501 + version (str, none_type): [optional] # noqa: E501 + deleted (bool, none_type): [optional] # noqa: E501 + updated_by (str, none_type): [optional] # noqa: E501 + created_by (str, none_type): [optional] # noqa: E501 + updated_at (datetime): [optional] # noqa: E501 + created_at (datetime): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.name = name + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/job.py b/src/apideck/model/job.py new file mode 100644 index 0000000000..de9fac2d9a --- /dev/null +++ b/src/apideck/model/job.py @@ -0,0 +1,435 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.address import Address + from apideck.model.branch import Branch + from apideck.model.department import Department + from apideck.model.job_salary import JobSalary + from apideck.model.job_status import JobStatus + from apideck.model.tags import Tags + globals()['Address'] = Address + globals()['Branch'] = Branch + globals()['Department'] = Department + globals()['JobSalary'] = JobSalary + globals()['JobStatus'] = JobStatus + globals()['Tags'] = Tags + + +class Job(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('visibility',): { + 'PUBLIC': "public", + 'INTERNAL': "internal", + }, + ('employment_terms',): { + 'None': None, + 'FULL-TIME': "full-time", + 'PART-TIME': "part-time", + 'INTERSHIP': "intership", + 'CONTRACTOR': "contractor", + 'EMPLOYEE': "employee", + 'FREELANCE': "freelance", + 'TEMP': "temp", + 'SEASONAL': "seasonal", + 'VOLUNTEER': "volunteer", + 'OTHER': "other", + }, + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'id': (str,), # noqa: E501 + 'slug': (str, none_type,), # noqa: E501 + 'title': (str, none_type,), # noqa: E501 + 'sequence': (int,), # noqa: E501 + 'visibility': (str,), # noqa: E501 + 'status': (JobStatus,), # noqa: E501 + 'code': (str,), # noqa: E501 + 'language': (str, none_type,), # noqa: E501 + 'employment_terms': (str, none_type,), # noqa: E501 + 'experience': (str,), # noqa: E501 + 'remote': (bool, none_type,), # noqa: E501 + 'requisition_id': (str,), # noqa: E501 + 'department': (Department,), # noqa: E501 + 'branch': (Branch,), # noqa: E501 + 'recruiters': ([str], none_type,), # noqa: E501 + 'hiring_managers': ([bool, date, datetime, dict, float, int, list, str, none_type],), # noqa: E501 + 'followers': ([str], none_type,), # noqa: E501 + 'description': (str, none_type,), # noqa: E501 + 'description_html': (str, none_type,), # noqa: E501 + 'blocks': ([bool, date, datetime, dict, float, int, list, str, none_type],), # noqa: E501 + 'closing': (str, none_type,), # noqa: E501 + 'closing_html': (str, none_type,), # noqa: E501 + 'closing_date': (date, none_type,), # noqa: E501 + 'salary': (JobSalary,), # noqa: E501 + 'url': (str, none_type,), # noqa: E501 + 'job_portal_url': (str, none_type,), # noqa: E501 + 'confidential': (bool,), # noqa: E501 + 'available_to_employees': (bool,), # noqa: E501 + 'tags': (Tags,), # noqa: E501 + 'addresses': ([Address],), # noqa: E501 + 'record_url': (str, none_type,), # noqa: E501 + 'deleted': (bool, none_type,), # noqa: E501 + 'owner_id': (str,), # noqa: E501 + 'published_at': (datetime,), # noqa: E501 + 'updated_by': (str, none_type,), # noqa: E501 + 'created_by': (str, none_type,), # noqa: E501 + 'updated_at': (datetime,), # noqa: E501 + 'created_at': (datetime,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'slug': 'slug', # noqa: E501 + 'title': 'title', # noqa: E501 + 'sequence': 'sequence', # noqa: E501 + 'visibility': 'visibility', # noqa: E501 + 'status': 'status', # noqa: E501 + 'code': 'code', # noqa: E501 + 'language': 'language', # noqa: E501 + 'employment_terms': 'employment_terms', # noqa: E501 + 'experience': 'experience', # noqa: E501 + 'remote': 'remote', # noqa: E501 + 'requisition_id': 'requisition_id', # noqa: E501 + 'department': 'department', # noqa: E501 + 'branch': 'branch', # noqa: E501 + 'recruiters': 'recruiters', # noqa: E501 + 'hiring_managers': 'hiring_managers', # noqa: E501 + 'followers': 'followers', # noqa: E501 + 'description': 'description', # noqa: E501 + 'description_html': 'description_html', # noqa: E501 + 'blocks': 'blocks', # noqa: E501 + 'closing': 'closing', # noqa: E501 + 'closing_html': 'closing_html', # noqa: E501 + 'closing_date': 'closing_date', # noqa: E501 + 'salary': 'salary', # noqa: E501 + 'url': 'url', # noqa: E501 + 'job_portal_url': 'job_portal_url', # noqa: E501 + 'confidential': 'confidential', # noqa: E501 + 'available_to_employees': 'available_to_employees', # noqa: E501 + 'tags': 'tags', # noqa: E501 + 'addresses': 'addresses', # noqa: E501 + 'record_url': 'record_url', # noqa: E501 + 'deleted': 'deleted', # noqa: E501 + 'owner_id': 'owner_id', # noqa: E501 + 'published_at': 'published_at', # noqa: E501 + 'updated_by': 'updated_by', # noqa: E501 + 'created_by': 'created_by', # noqa: E501 + 'updated_at': 'updated_at', # noqa: E501 + 'created_at': 'created_at', # noqa: E501 + } + + read_only_vars = { + 'id', # noqa: E501 + 'published_at', # noqa: E501 + 'updated_by', # noqa: E501 + 'created_by', # noqa: E501 + 'updated_at', # noqa: E501 + 'created_at', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """Job - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + slug (str, none_type): [optional] # noqa: E501 + title (str, none_type): [optional] # noqa: E501 + sequence (int): Sequence in relation to other jobs.. [optional] # noqa: E501 + visibility (str): The visibility of the job. [optional] # noqa: E501 + status (JobStatus): [optional] # noqa: E501 + code (str): The code of the job.. [optional] # noqa: E501 + language (str, none_type): language code according to ISO 639-1. For the United States - EN. [optional] # noqa: E501 + employment_terms (str, none_type): [optional] # noqa: E501 + experience (str): Level of experience required for the job role.. [optional] # noqa: E501 + remote (bool, none_type): Specifies whether the posting is for a remote job.. [optional] # noqa: E501 + requisition_id (str): A job's Requisition ID (Req ID) allows your organization to identify and track a job based on alphanumeric naming conventions unique to your company's internal processes.. [optional] # noqa: E501 + department (Department): [optional] # noqa: E501 + branch (Branch): [optional] # noqa: E501 + recruiters ([str], none_type): The recruiter is generally someone who is tasked to help the hiring manager find and screen qualified applicant. [optional] # noqa: E501 + hiring_managers ([bool, date, datetime, dict, float, int, list, str, none_type]): [optional] # noqa: E501 + followers ([str], none_type): [optional] # noqa: E501 + description (str, none_type): [optional] # noqa: E501 + description_html (str, none_type): The job description in HTML format. [optional] # noqa: E501 + blocks ([bool, date, datetime, dict, float, int, list, str, none_type]): [optional] # noqa: E501 + closing (str, none_type): [optional] # noqa: E501 + closing_html (str, none_type): The closing section of the job description in HTML format. [optional] # noqa: E501 + closing_date (date, none_type): [optional] # noqa: E501 + salary (JobSalary): [optional] # noqa: E501 + url (str, none_type): URL of the job description. [optional] # noqa: E501 + job_portal_url (str, none_type): URL of the job portal. [optional] # noqa: E501 + confidential (bool): [optional] # noqa: E501 + available_to_employees (bool): Specifies whether an employee of the organization can apply for the job.. [optional] # noqa: E501 + tags (Tags): [optional] # noqa: E501 + addresses ([Address]): [optional] # noqa: E501 + record_url (str, none_type): [optional] # noqa: E501 + deleted (bool, none_type): [optional] # noqa: E501 + owner_id (str): [optional] # noqa: E501 + published_at (datetime): [optional] # noqa: E501 + updated_by (str, none_type): [optional] # noqa: E501 + created_by (str, none_type): [optional] # noqa: E501 + updated_at (datetime): [optional] # noqa: E501 + created_at (datetime): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """Job - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + slug (str, none_type): [optional] # noqa: E501 + title (str, none_type): [optional] # noqa: E501 + sequence (int): Sequence in relation to other jobs.. [optional] # noqa: E501 + visibility (str): The visibility of the job. [optional] # noqa: E501 + status (JobStatus): [optional] # noqa: E501 + code (str): The code of the job.. [optional] # noqa: E501 + language (str, none_type): language code according to ISO 639-1. For the United States - EN. [optional] # noqa: E501 + employment_terms (str, none_type): [optional] # noqa: E501 + experience (str): Level of experience required for the job role.. [optional] # noqa: E501 + remote (bool, none_type): Specifies whether the posting is for a remote job.. [optional] # noqa: E501 + requisition_id (str): A job's Requisition ID (Req ID) allows your organization to identify and track a job based on alphanumeric naming conventions unique to your company's internal processes.. [optional] # noqa: E501 + department (Department): [optional] # noqa: E501 + branch (Branch): [optional] # noqa: E501 + recruiters ([str], none_type): The recruiter is generally someone who is tasked to help the hiring manager find and screen qualified applicant. [optional] # noqa: E501 + hiring_managers ([bool, date, datetime, dict, float, int, list, str, none_type]): [optional] # noqa: E501 + followers ([str], none_type): [optional] # noqa: E501 + description (str, none_type): [optional] # noqa: E501 + description_html (str, none_type): The job description in HTML format. [optional] # noqa: E501 + blocks ([bool, date, datetime, dict, float, int, list, str, none_type]): [optional] # noqa: E501 + closing (str, none_type): [optional] # noqa: E501 + closing_html (str, none_type): The closing section of the job description in HTML format. [optional] # noqa: E501 + closing_date (date, none_type): [optional] # noqa: E501 + salary (JobSalary): [optional] # noqa: E501 + url (str, none_type): URL of the job description. [optional] # noqa: E501 + job_portal_url (str, none_type): URL of the job portal. [optional] # noqa: E501 + confidential (bool): [optional] # noqa: E501 + available_to_employees (bool): Specifies whether an employee of the organization can apply for the job.. [optional] # noqa: E501 + tags (Tags): [optional] # noqa: E501 + addresses ([Address]): [optional] # noqa: E501 + record_url (str, none_type): [optional] # noqa: E501 + deleted (bool, none_type): [optional] # noqa: E501 + owner_id (str): [optional] # noqa: E501 + published_at (datetime): [optional] # noqa: E501 + updated_by (str, none_type): [optional] # noqa: E501 + created_by (str, none_type): [optional] # noqa: E501 + updated_at (datetime): [optional] # noqa: E501 + created_at (datetime): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/job_salary.py b/src/apideck/model/job_salary.py new file mode 100644 index 0000000000..4b71cb59ef --- /dev/null +++ b/src/apideck/model/job_salary.py @@ -0,0 +1,269 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.currency import Currency + globals()['Currency'] = Currency + + +class JobSalary(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'min': (int,), # noqa: E501 + 'max': (int,), # noqa: E501 + 'currency': (Currency,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'min': 'min', # noqa: E501 + 'max': 'max', # noqa: E501 + 'currency': 'currency', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """JobSalary - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + min (int): Minimum salary payable for the job role.. [optional] # noqa: E501 + max (int): Maximum salary payable for the job role.. [optional] # noqa: E501 + currency (Currency): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """JobSalary - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + min (int): Minimum salary payable for the job role.. [optional] # noqa: E501 + max (int): Maximum salary payable for the job role.. [optional] # noqa: E501 + currency (Currency): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/job_status.py b/src/apideck/model/job_status.py new file mode 100644 index 0000000000..88602c67c2 --- /dev/null +++ b/src/apideck/model/job_status.py @@ -0,0 +1,286 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class JobStatus(ModelSimple): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('value',): { + 'DRAFT': "draft", + 'INTERNAL': "internal", + 'PUBLISHED': "published", + 'COMPLETED': "completed", + 'ON-HOLD': "on-hold", + 'PRIVATE': "private", + }, + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'value': (str,), + } + + @cached_property + def discriminator(): + return None + + + attribute_map = {} + + read_only_vars = set() + + _composed_schemas = None + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): + """JobStatus - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] (str): The status of the job.., must be one of ["draft", "internal", "published", "completed", "on-hold", "private", ] # noqa: E501 + + Keyword Args: + value (str): The status of the job.., must be one of ["draft", "internal", "published", "completed", "on-hold", "private", ] # noqa: E501 + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + self.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): + """JobStatus - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] (str): The status of the job.., must be one of ["draft", "internal", "published", "completed", "on-hold", "private", ] # noqa: E501 + + Keyword Args: + value (str): The status of the job.., must be one of ["draft", "internal", "published", "completed", "on-hold", "private", ] # noqa: E501 + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + self.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + return self diff --git a/src/apideck/model/jobs_filter.py b/src/apideck/model/jobs_filter.py new file mode 100644 index 0000000000..708e2c6e00 --- /dev/null +++ b/src/apideck/model/jobs_filter.py @@ -0,0 +1,249 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class JobsFilter(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'job_id': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'job_id': 'job_id', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """JobsFilter - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + job_id (str): Id of the job to filter on. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """JobsFilter - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + job_id (str): Id of the job to filter on. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/lead.py b/src/apideck/model/lead.py new file mode 100644 index 0000000000..59f373c4e0 --- /dev/null +++ b/src/apideck/model/lead.py @@ -0,0 +1,382 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.address import Address + from apideck.model.currency import Currency + from apideck.model.custom_field import CustomField + from apideck.model.email import Email + from apideck.model.phone_number import PhoneNumber + from apideck.model.social_link import SocialLink + from apideck.model.tags import Tags + from apideck.model.website import Website + globals()['Address'] = Address + globals()['Currency'] = Currency + globals()['CustomField'] = CustomField + globals()['Email'] = Email + globals()['PhoneNumber'] = PhoneNumber + globals()['SocialLink'] = SocialLink + globals()['Tags'] = Tags + globals()['Website'] = Website + + +class Lead(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + ('name',): { + 'min_length': 1, + }, + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'name': (str,), # noqa: E501 + 'company_name': (str, none_type,), # noqa: E501 + 'id': (str,), # noqa: E501 + 'owner_id': (str,), # noqa: E501 + 'company_id': (str, none_type,), # noqa: E501 + 'contact_id': (str, none_type,), # noqa: E501 + 'lead_source': (str, none_type,), # noqa: E501 + 'first_name': (str, none_type,), # noqa: E501 + 'last_name': (str, none_type,), # noqa: E501 + 'description': (str, none_type,), # noqa: E501 + 'prefix': (str, none_type,), # noqa: E501 + 'title': (str, none_type,), # noqa: E501 + 'language': (str, none_type,), # noqa: E501 + 'status': (str, none_type,), # noqa: E501 + 'monetary_amount': (float, none_type,), # noqa: E501 + 'currency': (Currency,), # noqa: E501 + 'fax': (str, none_type,), # noqa: E501 + 'websites': ([Website],), # noqa: E501 + 'addresses': ([Address],), # noqa: E501 + 'social_links': ([SocialLink],), # noqa: E501 + 'phone_numbers': ([PhoneNumber],), # noqa: E501 + 'emails': ([Email],), # noqa: E501 + 'custom_fields': ([CustomField],), # noqa: E501 + 'tags': (Tags,), # noqa: E501 + 'updated_at': (str,), # noqa: E501 + 'created_at': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'name': 'name', # noqa: E501 + 'company_name': 'company_name', # noqa: E501 + 'id': 'id', # noqa: E501 + 'owner_id': 'owner_id', # noqa: E501 + 'company_id': 'company_id', # noqa: E501 + 'contact_id': 'contact_id', # noqa: E501 + 'lead_source': 'lead_source', # noqa: E501 + 'first_name': 'first_name', # noqa: E501 + 'last_name': 'last_name', # noqa: E501 + 'description': 'description', # noqa: E501 + 'prefix': 'prefix', # noqa: E501 + 'title': 'title', # noqa: E501 + 'language': 'language', # noqa: E501 + 'status': 'status', # noqa: E501 + 'monetary_amount': 'monetary_amount', # noqa: E501 + 'currency': 'currency', # noqa: E501 + 'fax': 'fax', # noqa: E501 + 'websites': 'websites', # noqa: E501 + 'addresses': 'addresses', # noqa: E501 + 'social_links': 'social_links', # noqa: E501 + 'phone_numbers': 'phone_numbers', # noqa: E501 + 'emails': 'emails', # noqa: E501 + 'custom_fields': 'custom_fields', # noqa: E501 + 'tags': 'tags', # noqa: E501 + 'updated_at': 'updated_at', # noqa: E501 + 'created_at': 'created_at', # noqa: E501 + } + + read_only_vars = { + 'id', # noqa: E501 + 'updated_at', # noqa: E501 + 'created_at', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, name, company_name, *args, **kwargs): # noqa: E501 + """Lead - a model defined in OpenAPI + + Args: + name (str): + company_name (str, none_type): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + owner_id (str): [optional] # noqa: E501 + company_id (str, none_type): [optional] # noqa: E501 + contact_id (str, none_type): [optional] # noqa: E501 + lead_source (str, none_type): [optional] # noqa: E501 + first_name (str, none_type): [optional] # noqa: E501 + last_name (str, none_type): [optional] # noqa: E501 + description (str, none_type): [optional] # noqa: E501 + prefix (str, none_type): [optional] # noqa: E501 + title (str, none_type): [optional] # noqa: E501 + language (str, none_type): language code according to ISO 639-1. For the United States - EN. [optional] # noqa: E501 + status (str, none_type): [optional] # noqa: E501 + monetary_amount (float, none_type): [optional] # noqa: E501 + currency (Currency): [optional] # noqa: E501 + fax (str, none_type): [optional] # noqa: E501 + websites ([Website]): [optional] # noqa: E501 + addresses ([Address]): [optional] # noqa: E501 + social_links ([SocialLink]): [optional] # noqa: E501 + phone_numbers ([PhoneNumber]): [optional] # noqa: E501 + emails ([Email]): [optional] # noqa: E501 + custom_fields ([CustomField]): [optional] # noqa: E501 + tags (Tags): [optional] # noqa: E501 + updated_at (str): [optional] # noqa: E501 + created_at (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.name = name + self.company_name = company_name + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, name, company_name, *args, **kwargs): # noqa: E501 + """Lead - a model defined in OpenAPI + + Args: + name (str): + company_name (str, none_type): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + owner_id (str): [optional] # noqa: E501 + company_id (str, none_type): [optional] # noqa: E501 + contact_id (str, none_type): [optional] # noqa: E501 + lead_source (str, none_type): [optional] # noqa: E501 + first_name (str, none_type): [optional] # noqa: E501 + last_name (str, none_type): [optional] # noqa: E501 + description (str, none_type): [optional] # noqa: E501 + prefix (str, none_type): [optional] # noqa: E501 + title (str, none_type): [optional] # noqa: E501 + language (str, none_type): language code according to ISO 639-1. For the United States - EN. [optional] # noqa: E501 + status (str, none_type): [optional] # noqa: E501 + monetary_amount (float, none_type): [optional] # noqa: E501 + currency (Currency): [optional] # noqa: E501 + fax (str, none_type): [optional] # noqa: E501 + websites ([Website]): [optional] # noqa: E501 + addresses ([Address]): [optional] # noqa: E501 + social_links ([SocialLink]): [optional] # noqa: E501 + phone_numbers ([PhoneNumber]): [optional] # noqa: E501 + emails ([Email]): [optional] # noqa: E501 + custom_fields ([CustomField]): [optional] # noqa: E501 + tags (Tags): [optional] # noqa: E501 + updated_at (str): [optional] # noqa: E501 + created_at (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.name = name + self.company_name = company_name + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/lead_event_type.py b/src/apideck/model/lead_event_type.py new file mode 100644 index 0000000000..1926eafd8f --- /dev/null +++ b/src/apideck/model/lead_event_type.py @@ -0,0 +1,284 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class LeadEventType(ModelSimple): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('value',): { + '*': "*", + 'LEAD.LEAD.CREATED': "lead.lead.created", + 'LEAD.LEAD.UPDATED': "lead.lead.updated", + 'LEAD.LEAD.DELETED': "lead.lead.deleted", + }, + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'value': (str,), + } + + @cached_property + def discriminator(): + return None + + + attribute_map = {} + + read_only_vars = set() + + _composed_schemas = None + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): + """LeadEventType - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] (str):, must be one of ["*", "lead.lead.created", "lead.lead.updated", "lead.lead.deleted", ] # noqa: E501 + + Keyword Args: + value (str):, must be one of ["*", "lead.lead.created", "lead.lead.updated", "lead.lead.deleted", ] # noqa: E501 + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + self.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): + """LeadEventType - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] (str):, must be one of ["*", "lead.lead.created", "lead.lead.updated", "lead.lead.deleted", ] # noqa: E501 + + Keyword Args: + value (str):, must be one of ["*", "lead.lead.created", "lead.lead.updated", "lead.lead.deleted", ] # noqa: E501 + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + self.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + return self diff --git a/src/apideck/model/leads_filter.py b/src/apideck/model/leads_filter.py new file mode 100644 index 0000000000..cb7f39f90d --- /dev/null +++ b/src/apideck/model/leads_filter.py @@ -0,0 +1,261 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class LeadsFilter(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'name': (str,), # noqa: E501 + 'first_name': (str,), # noqa: E501 + 'last_name': (str,), # noqa: E501 + 'email': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'name': 'name', # noqa: E501 + 'first_name': 'first_name', # noqa: E501 + 'last_name': 'last_name', # noqa: E501 + 'email': 'email', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """LeadsFilter - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + name (str): Name of the lead to filter on. [optional] # noqa: E501 + first_name (str): First name of the lead to filter on. [optional] # noqa: E501 + last_name (str): Last name of the lead to filter on. [optional] # noqa: E501 + email (str): E-mail of the lead to filter on. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """LeadsFilter - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + name (str): Name of the lead to filter on. [optional] # noqa: E501 + first_name (str): First name of the lead to filter on. [optional] # noqa: E501 + last_name (str): Last name of the lead to filter on. [optional] # noqa: E501 + email (str): E-mail of the lead to filter on. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/leads_sort.py b/src/apideck/model/leads_sort.py new file mode 100644 index 0000000000..df6a1bb202 --- /dev/null +++ b/src/apideck/model/leads_sort.py @@ -0,0 +1,266 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.sort_direction import SortDirection + globals()['SortDirection'] = SortDirection + + +class LeadsSort(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('by',): { + 'CREATED_AT': "created_at", + 'UPDATED_AT': "updated_at", + 'NAME': "name", + 'FIRST_NAME': "first_name", + 'LAST_NAME': "last_name", + 'EMAIL': "email", + }, + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'by': (str,), # noqa: E501 + 'direction': (SortDirection,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'by': 'by', # noqa: E501 + 'direction': 'direction', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """LeadsSort - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + by (str): The field on which to sort the Leads. [optional] # noqa: E501 + direction (SortDirection): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """LeadsSort - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + by (str): The field on which to sort the Leads. [optional] # noqa: E501 + direction (SortDirection): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/ledger_account.py b/src/apideck/model/ledger_account.py new file mode 100644 index 0000000000..31f7d52404 --- /dev/null +++ b/src/apideck/model/ledger_account.py @@ -0,0 +1,431 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.bank_account import BankAccount + from apideck.model.currency import Currency + from apideck.model.ledger_account_categories import LedgerAccountCategories + from apideck.model.ledger_account_parent_account import LedgerAccountParentAccount + from apideck.model.linked_tax_rate import LinkedTaxRate + globals()['BankAccount'] = BankAccount + globals()['Currency'] = Currency + globals()['LedgerAccountCategories'] = LedgerAccountCategories + globals()['LedgerAccountParentAccount'] = LedgerAccountParentAccount + globals()['LinkedTaxRate'] = LinkedTaxRate + + +class LedgerAccount(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('classification',): { + 'None': None, + 'ASSET': "asset", + 'EQUITY': "equity", + 'EXPENSE': "expense", + 'LIABILITY': "liability", + 'REVENUE': "revenue", + 'INCOME': "income", + 'OTHER_INCOME': "other_income", + 'OTHER_EXPENSE': "other_expense", + 'COSTS_OF_SALES': "costs_of_sales", + }, + ('type',): { + 'ACCOUNTS_RECEIVABLE': "accounts_receivable", + 'REVENUE': "revenue", + 'SALES': "sales", + 'OTHER_INCOME': "other_income", + 'BANK': "bank", + 'CURRENT_ASSET': "current_asset", + 'FIXED_ASSET': "fixed_asset", + 'NON_CURRENT_ASSET': "non_current_asset", + 'OTHER_ASSET': "other_asset", + 'BALANCESHEET': "balancesheet", + 'EQUITY': "equity", + 'EXPENSE': "expense", + 'OTHER_EXPENSE': "other_expense", + 'COSTS_OF_SALES': "costs_of_sales", + 'ACCOUNTS_PAYABLE': "accounts_payable", + 'CREDIT_CARD': "credit_card", + 'CURRENT_LIABILITY': "current_liability", + 'NON_CURRENT_LIABILITY': "non_current_liability", + 'OTHER_LIABILITY': "other_liability", + }, + ('status',): { + 'None': None, + 'ACTIVE': "active", + 'INACTIVE': "inactive", + 'ARCHIVED': "archived", + }, + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'id': (str,), # noqa: E501 + 'display_id': (str,), # noqa: E501 + 'nominal_code': (str, none_type,), # noqa: E501 + 'code': (str, none_type,), # noqa: E501 + 'classification': (str, none_type,), # noqa: E501 + 'type': (str,), # noqa: E501 + 'sub_type': (str, none_type,), # noqa: E501 + 'name': (str, none_type,), # noqa: E501 + 'fully_qualified_name': (str, none_type,), # noqa: E501 + 'description': (str, none_type,), # noqa: E501 + 'opening_balance': (float, none_type,), # noqa: E501 + 'current_balance': (float, none_type,), # noqa: E501 + 'currency': (Currency,), # noqa: E501 + 'tax_type': (str, none_type,), # noqa: E501 + 'tax_rate': (LinkedTaxRate,), # noqa: E501 + 'level': (float, none_type,), # noqa: E501 + 'active': (bool, none_type,), # noqa: E501 + 'status': (str, none_type,), # noqa: E501 + 'header': (bool, none_type,), # noqa: E501 + 'bank_account': (BankAccount,), # noqa: E501 + 'categories': ([LedgerAccountCategories],), # noqa: E501 + 'parent_account': (LedgerAccountParentAccount,), # noqa: E501 + 'sub_account': (bool, none_type,), # noqa: E501 + 'sub_accounts': ([bool, date, datetime, dict, float, int, list, str, none_type],), # noqa: E501 + 'last_reconciliation_date': (date, none_type,), # noqa: E501 + 'row_version': (str, none_type,), # noqa: E501 + 'updated_by': (str, none_type,), # noqa: E501 + 'created_by': (str, none_type,), # noqa: E501 + 'updated_at': (datetime,), # noqa: E501 + 'created_at': (datetime,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'display_id': 'display_id', # noqa: E501 + 'nominal_code': 'nominal_code', # noqa: E501 + 'code': 'code', # noqa: E501 + 'classification': 'classification', # noqa: E501 + 'type': 'type', # noqa: E501 + 'sub_type': 'sub_type', # noqa: E501 + 'name': 'name', # noqa: E501 + 'fully_qualified_name': 'fully_qualified_name', # noqa: E501 + 'description': 'description', # noqa: E501 + 'opening_balance': 'opening_balance', # noqa: E501 + 'current_balance': 'current_balance', # noqa: E501 + 'currency': 'currency', # noqa: E501 + 'tax_type': 'tax_type', # noqa: E501 + 'tax_rate': 'tax_rate', # noqa: E501 + 'level': 'level', # noqa: E501 + 'active': 'active', # noqa: E501 + 'status': 'status', # noqa: E501 + 'header': 'header', # noqa: E501 + 'bank_account': 'bank_account', # noqa: E501 + 'categories': 'categories', # noqa: E501 + 'parent_account': 'parent_account', # noqa: E501 + 'sub_account': 'sub_account', # noqa: E501 + 'sub_accounts': 'sub_accounts', # noqa: E501 + 'last_reconciliation_date': 'last_reconciliation_date', # noqa: E501 + 'row_version': 'row_version', # noqa: E501 + 'updated_by': 'updated_by', # noqa: E501 + 'created_by': 'created_by', # noqa: E501 + 'updated_at': 'updated_at', # noqa: E501 + 'created_at': 'created_at', # noqa: E501 + } + + read_only_vars = { + 'id', # noqa: E501 + 'categories', # noqa: E501 + 'sub_accounts', # noqa: E501 + 'updated_by', # noqa: E501 + 'created_by', # noqa: E501 + 'updated_at', # noqa: E501 + 'created_at', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """LedgerAccount - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + display_id (str): The human readable display ID used when displaying the account. [optional] # noqa: E501 + nominal_code (str, none_type): The nominal code of the ledger account.. [optional] # noqa: E501 + code (str, none_type): The code assigned to the account.. [optional] # noqa: E501 + classification (str, none_type): The classification of account.. [optional] # noqa: E501 + type (str): The type of account.. [optional] # noqa: E501 + sub_type (str, none_type): The sub type of account.. [optional] # noqa: E501 + name (str, none_type): The name of the account.. [optional] # noqa: E501 + fully_qualified_name (str, none_type): The fully qualified name of the account.. [optional] # noqa: E501 + description (str, none_type): The description of the account.. [optional] # noqa: E501 + opening_balance (float, none_type): The opening balance of the account.. [optional] # noqa: E501 + current_balance (float, none_type): The current balance of the account.. [optional] # noqa: E501 + currency (Currency): [optional] # noqa: E501 + tax_type (str, none_type): The tax type of the account.. [optional] # noqa: E501 + tax_rate (LinkedTaxRate): [optional] # noqa: E501 + level (float, none_type): [optional] # noqa: E501 + active (bool, none_type): Whether the account is active or not.. [optional] # noqa: E501 + status (str, none_type): The status of the account.. [optional] # noqa: E501 + header (bool, none_type): Whether the account is a header or not.. [optional] # noqa: E501 + bank_account (BankAccount): [optional] # noqa: E501 + categories ([LedgerAccountCategories]): The categories of the account.. [optional] # noqa: E501 + parent_account (LedgerAccountParentAccount): [optional] # noqa: E501 + sub_account (bool, none_type): Whether the account is a sub account or not.. [optional] # noqa: E501 + sub_accounts ([bool, date, datetime, dict, float, int, list, str, none_type]): The sub accounts of the account.. [optional] # noqa: E501 + last_reconciliation_date (date, none_type): Reconciliation Date means the last calendar day of each Reconciliation Period.. [optional] # noqa: E501 + row_version (str, none_type): [optional] # noqa: E501 + updated_by (str, none_type): [optional] # noqa: E501 + created_by (str, none_type): [optional] # noqa: E501 + updated_at (datetime): [optional] # noqa: E501 + created_at (datetime): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """LedgerAccount - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + display_id (str): The human readable display ID used when displaying the account. [optional] # noqa: E501 + nominal_code (str, none_type): The nominal code of the ledger account.. [optional] # noqa: E501 + code (str, none_type): The code assigned to the account.. [optional] # noqa: E501 + classification (str, none_type): The classification of account.. [optional] # noqa: E501 + type (str): The type of account.. [optional] # noqa: E501 + sub_type (str, none_type): The sub type of account.. [optional] # noqa: E501 + name (str, none_type): The name of the account.. [optional] # noqa: E501 + fully_qualified_name (str, none_type): The fully qualified name of the account.. [optional] # noqa: E501 + description (str, none_type): The description of the account.. [optional] # noqa: E501 + opening_balance (float, none_type): The opening balance of the account.. [optional] # noqa: E501 + current_balance (float, none_type): The current balance of the account.. [optional] # noqa: E501 + currency (Currency): [optional] # noqa: E501 + tax_type (str, none_type): The tax type of the account.. [optional] # noqa: E501 + tax_rate (LinkedTaxRate): [optional] # noqa: E501 + level (float, none_type): [optional] # noqa: E501 + active (bool, none_type): Whether the account is active or not.. [optional] # noqa: E501 + status (str, none_type): The status of the account.. [optional] # noqa: E501 + header (bool, none_type): Whether the account is a header or not.. [optional] # noqa: E501 + bank_account (BankAccount): [optional] # noqa: E501 + categories ([LedgerAccountCategories]): The categories of the account.. [optional] # noqa: E501 + parent_account (LedgerAccountParentAccount): [optional] # noqa: E501 + sub_account (bool, none_type): Whether the account is a sub account or not.. [optional] # noqa: E501 + sub_accounts ([bool, date, datetime, dict, float, int, list, str, none_type]): The sub accounts of the account.. [optional] # noqa: E501 + last_reconciliation_date (date, none_type): Reconciliation Date means the last calendar day of each Reconciliation Period.. [optional] # noqa: E501 + row_version (str, none_type): [optional] # noqa: E501 + updated_by (str, none_type): [optional] # noqa: E501 + created_by (str, none_type): [optional] # noqa: E501 + updated_at (datetime): [optional] # noqa: E501 + created_at (datetime): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/ledger_account_categories.py b/src/apideck/model/ledger_account_categories.py new file mode 100644 index 0000000000..a8b8e7c6f6 --- /dev/null +++ b/src/apideck/model/ledger_account_categories.py @@ -0,0 +1,261 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class LedgerAccountCategories(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'id': (str,), # noqa: E501 + 'name': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'name': 'name', # noqa: E501 + } + + read_only_vars = { + 'id', # noqa: E501 + 'name', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """LedgerAccountCategories - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + name (str): The name of the category.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """LedgerAccountCategories - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + name (str): The name of the category.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/ledger_account_parent_account.py b/src/apideck/model/ledger_account_parent_account.py new file mode 100644 index 0000000000..539745ce88 --- /dev/null +++ b/src/apideck/model/ledger_account_parent_account.py @@ -0,0 +1,263 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class LedgerAccountParentAccount(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'id': (str,), # noqa: E501 + 'name': (str,), # noqa: E501 + 'display_id': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'name': 'name', # noqa: E501 + 'display_id': 'display_id', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """LedgerAccountParentAccount - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): The ID of the parent account.. [optional] # noqa: E501 + name (str): The name of the parent account.. [optional] # noqa: E501 + display_id (str): The human readable display ID used when displaying the parent account. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """LedgerAccountParentAccount - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): The ID of the parent account.. [optional] # noqa: E501 + name (str): The name of the parent account.. [optional] # noqa: E501 + display_id (str): The human readable display ID used when displaying the parent account. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/ledger_accounts.py b/src/apideck/model/ledger_accounts.py new file mode 100644 index 0000000000..0293645904 --- /dev/null +++ b/src/apideck/model/ledger_accounts.py @@ -0,0 +1,283 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.ledger_account import LedgerAccount + globals()['LedgerAccount'] = LedgerAccount + + +class LedgerAccounts(ModelSimple): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'value': ([LedgerAccount],), + } + + @cached_property + def discriminator(): + return None + + + attribute_map = {} + + read_only_vars = set() + + _composed_schemas = None + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): + """LedgerAccounts - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] ([LedgerAccount]): # noqa: E501 + + Keyword Args: + value ([LedgerAccount]): # noqa: E501 + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + self.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): + """LedgerAccounts - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] ([LedgerAccount]): # noqa: E501 + + Keyword Args: + value ([LedgerAccount]): # noqa: E501 + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + self.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + return self diff --git a/src/apideck/model/linked_connector_resource.py b/src/apideck/model/linked_connector_resource.py new file mode 100644 index 0000000000..6a1ab87673 --- /dev/null +++ b/src/apideck/model/linked_connector_resource.py @@ -0,0 +1,277 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.resource_status import ResourceStatus + globals()['ResourceStatus'] = ResourceStatus + + +class LinkedConnectorResource(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'id': (str,), # noqa: E501 + 'name': (str,), # noqa: E501 + 'status': (ResourceStatus,), # noqa: E501 + 'downstream_id': (str,), # noqa: E501 + 'downstream_name': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'name': 'name', # noqa: E501 + 'status': 'status', # noqa: E501 + 'downstream_id': 'downstream_id', # noqa: E501 + 'downstream_name': 'downstream_name', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """LinkedConnectorResource - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): ID of the resource, typically a lowercased version of name.. [optional] # noqa: E501 + name (str): Name of the resource (plural). [optional] # noqa: E501 + status (ResourceStatus): [optional] # noqa: E501 + downstream_id (str): ID of the resource in the Connector's API (downstream). [optional] # noqa: E501 + downstream_name (str): Name of the resource in the Connector's API (downstream). [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """LinkedConnectorResource - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): ID of the resource, typically a lowercased version of name.. [optional] # noqa: E501 + name (str): Name of the resource (plural). [optional] # noqa: E501 + status (ResourceStatus): [optional] # noqa: E501 + downstream_id (str): ID of the resource in the Connector's API (downstream). [optional] # noqa: E501 + downstream_name (str): Name of the resource in the Connector's API (downstream). [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/linked_customer.py b/src/apideck/model/linked_customer.py new file mode 100644 index 0000000000..cb0fba0194 --- /dev/null +++ b/src/apideck/model/linked_customer.py @@ -0,0 +1,279 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class LinkedCustomer(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = True + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'id': (str,), # noqa: E501 + 'display_id': (str, none_type,), # noqa: E501 + 'display_name': (str, none_type,), # noqa: E501 + 'name': (str,), # noqa: E501 + 'company_name': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'display_id': 'display_id', # noqa: E501 + 'display_name': 'display_name', # noqa: E501 + 'name': 'name', # noqa: E501 + 'company_name': 'company_name', # noqa: E501 + } + + read_only_vars = { + 'display_id', # noqa: E501 + 'company_name', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 + """LinkedCustomer - a model defined in OpenAPI + + Args: + id (str): The ID of the customer this entity is linked to. + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + display_id (str, none_type): The display ID of the customer.. [optional] # noqa: E501 + display_name (str, none_type): The display name of the customer.. [optional] # noqa: E501 + name (str): The name of the customer. Deprecated, use display_name instead.. [optional] # noqa: E501 + company_name (str, none_type): The company name of the customer.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.id = id + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, id, *args, **kwargs): # noqa: E501 + """LinkedCustomer - a model defined in OpenAPI + + Args: + id (str): The ID of the customer this entity is linked to. + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + display_id (str, none_type): The display ID of the customer.. [optional] # noqa: E501 + display_name (str, none_type): The display name of the customer.. [optional] # noqa: E501 + name (str): The name of the customer. Deprecated, use display_name instead.. [optional] # noqa: E501 + company_name (str, none_type): The company name of the customer.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.id = id + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/linked_folder.py b/src/apideck/model/linked_folder.py new file mode 100644 index 0000000000..2e1188d8c7 --- /dev/null +++ b/src/apideck/model/linked_folder.py @@ -0,0 +1,262 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class LinkedFolder(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'id': (str,), # noqa: E501 + 'name': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'name': 'name', # noqa: E501 + } + + read_only_vars = { + 'id', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 + """LinkedFolder - a model defined in OpenAPI + + Args: + id (str): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + name (str): The name of the folder. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.id = id + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """LinkedFolder - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + name (str): The name of the folder. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/linked_invoice_item.py b/src/apideck/model/linked_invoice_item.py new file mode 100644 index 0000000000..54a34ec527 --- /dev/null +++ b/src/apideck/model/linked_invoice_item.py @@ -0,0 +1,265 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class LinkedInvoiceItem(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'id': (str, none_type,), # noqa: E501 + 'code': (str, none_type,), # noqa: E501 + 'name': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'code': 'code', # noqa: E501 + 'name': 'name', # noqa: E501 + } + + read_only_vars = { + 'code', # noqa: E501 + 'name', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """LinkedInvoiceItem - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str, none_type): ID of the linked item. A reference to the [invoice item](https://developers.apideck.com/apis/accounting/reference#tag/Invoice-Items) that was used to create this line item. [optional] # noqa: E501 + code (str, none_type): User defined item code. [optional] # noqa: E501 + name (str, none_type): User defined item name. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """LinkedInvoiceItem - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str, none_type): ID of the linked item. A reference to the [invoice item](https://developers.apideck.com/apis/accounting/reference#tag/Invoice-Items) that was used to create this line item. [optional] # noqa: E501 + code (str, none_type): User defined item code. [optional] # noqa: E501 + name (str, none_type): User defined item name. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/linked_ledger_account.py b/src/apideck/model/linked_ledger_account.py new file mode 100644 index 0000000000..66839f0202 --- /dev/null +++ b/src/apideck/model/linked_ledger_account.py @@ -0,0 +1,268 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class LinkedLedgerAccount(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = True + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'id': (str,), # noqa: E501 + 'name': (str, none_type,), # noqa: E501 + 'nominal_code': (str, none_type,), # noqa: E501 + 'code': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'name': 'name', # noqa: E501 + 'nominal_code': 'nominal_code', # noqa: E501 + 'code': 'code', # noqa: E501 + } + + read_only_vars = { + 'name', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """LinkedLedgerAccount - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): The unique identifier for the account.. [optional] # noqa: E501 + name (str, none_type): The name of the account.. [optional] # noqa: E501 + nominal_code (str, none_type): The nominal code of the account.. [optional] # noqa: E501 + code (str, none_type): The code assigned to the account.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """LinkedLedgerAccount - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): The unique identifier for the account.. [optional] # noqa: E501 + name (str, none_type): The name of the account.. [optional] # noqa: E501 + nominal_code (str, none_type): The nominal code of the account.. [optional] # noqa: E501 + code (str, none_type): The code assigned to the account.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/linked_supplier.py b/src/apideck/model/linked_supplier.py new file mode 100644 index 0000000000..b0519d97c3 --- /dev/null +++ b/src/apideck/model/linked_supplier.py @@ -0,0 +1,280 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.address import Address + globals()['Address'] = Address + + +class LinkedSupplier(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = True + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'id': (str,), # noqa: E501 + 'display_name': (str, none_type,), # noqa: E501 + 'company_name': (str, none_type,), # noqa: E501 + 'address': (Address,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'display_name': 'display_name', # noqa: E501 + 'company_name': 'company_name', # noqa: E501 + 'address': 'address', # noqa: E501 + } + + read_only_vars = { + 'company_name', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 + """LinkedSupplier - a model defined in OpenAPI + + Args: + id (str): The ID of the supplier this entity is linked to. + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + display_name (str, none_type): The display name of the supplier.. [optional] # noqa: E501 + company_name (str, none_type): The company name of the supplier.. [optional] # noqa: E501 + address (Address): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.id = id + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, id, *args, **kwargs): # noqa: E501 + """LinkedSupplier - a model defined in OpenAPI + + Args: + id (str): The ID of the supplier this entity is linked to. + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + display_name (str, none_type): The display name of the supplier.. [optional] # noqa: E501 + company_name (str, none_type): The company name of the supplier.. [optional] # noqa: E501 + address (Address): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.id = id + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/linked_tax_rate.py b/src/apideck/model/linked_tax_rate.py new file mode 100644 index 0000000000..142c90d167 --- /dev/null +++ b/src/apideck/model/linked_tax_rate.py @@ -0,0 +1,265 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class LinkedTaxRate(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'id': (str, none_type,), # noqa: E501 + 'code': (str, none_type,), # noqa: E501 + 'name': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'code': 'code', # noqa: E501 + 'name': 'name', # noqa: E501 + } + + read_only_vars = { + 'code', # noqa: E501 + 'name', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """LinkedTaxRate - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str, none_type): The ID of the object.. [optional] # noqa: E501 + code (str, none_type): Tax rate code. [optional] # noqa: E501 + name (str, none_type): Name of the tax rate. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """LinkedTaxRate - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str, none_type): The ID of the object.. [optional] # noqa: E501 + code (str, none_type): Tax rate code. [optional] # noqa: E501 + name (str, none_type): Name of the tax rate. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/links.py b/src/apideck/model/links.py new file mode 100644 index 0000000000..c0e44e3806 --- /dev/null +++ b/src/apideck/model/links.py @@ -0,0 +1,263 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class Links(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'previous': (str, none_type,), # noqa: E501 + 'current': (str,), # noqa: E501 + 'next': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'previous': 'previous', # noqa: E501 + 'current': 'current', # noqa: E501 + 'next': 'next', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """Links - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + previous (str, none_type): Link to navigate to the previous page through the API. [optional] # noqa: E501 + current (str): Link to navigate to the current page through the API. [optional] # noqa: E501 + next (str, none_type): Link to navigate to the previous page through the API. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """Links - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + previous (str, none_type): Link to navigate to the previous page through the API. [optional] # noqa: E501 + current (str): Link to navigate to the current page through the API. [optional] # noqa: E501 + next (str, none_type): Link to navigate to the previous page through the API. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/location.py b/src/apideck/model/location.py new file mode 100644 index 0000000000..3a0fadeeb3 --- /dev/null +++ b/src/apideck/model/location.py @@ -0,0 +1,307 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.address import Address + from apideck.model.currency import Currency + globals()['Address'] = Address + globals()['Currency'] = Currency + + +class Location(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('status',): { + 'None': None, + 'ACTIVE': "active", + 'INACTIVE': "inactive", + 'OTHER': "other", + }, + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'id': (str,), # noqa: E501 + 'name': (str, none_type,), # noqa: E501 + 'business_name': (str, none_type,), # noqa: E501 + 'address': (Address,), # noqa: E501 + 'status': (str, none_type,), # noqa: E501 + 'merchant_id': (str,), # noqa: E501 + 'currency': (Currency,), # noqa: E501 + 'updated_by': (str, none_type,), # noqa: E501 + 'created_by': (str, none_type,), # noqa: E501 + 'updated_at': (datetime,), # noqa: E501 + 'created_at': (datetime,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'name': 'name', # noqa: E501 + 'business_name': 'business_name', # noqa: E501 + 'address': 'address', # noqa: E501 + 'status': 'status', # noqa: E501 + 'merchant_id': 'merchant_id', # noqa: E501 + 'currency': 'currency', # noqa: E501 + 'updated_by': 'updated_by', # noqa: E501 + 'created_by': 'created_by', # noqa: E501 + 'updated_at': 'updated_at', # noqa: E501 + 'created_at': 'created_at', # noqa: E501 + } + + read_only_vars = { + 'id', # noqa: E501 + 'updated_by', # noqa: E501 + 'created_by', # noqa: E501 + 'updated_at', # noqa: E501 + 'created_at', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """Location - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + name (str, none_type): The name of the location. [optional] # noqa: E501 + business_name (str, none_type): The business name of the location. [optional] # noqa: E501 + address (Address): [optional] # noqa: E501 + status (str, none_type): Status of this location.. [optional] # noqa: E501 + merchant_id (str): [optional] # noqa: E501 + currency (Currency): [optional] # noqa: E501 + updated_by (str, none_type): [optional] # noqa: E501 + created_by (str, none_type): [optional] # noqa: E501 + updated_at (datetime): [optional] # noqa: E501 + created_at (datetime): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """Location - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + name (str, none_type): The name of the location. [optional] # noqa: E501 + business_name (str, none_type): The business name of the location. [optional] # noqa: E501 + address (Address): [optional] # noqa: E501 + status (str, none_type): Status of this location.. [optional] # noqa: E501 + merchant_id (str): [optional] # noqa: E501 + currency (Currency): [optional] # noqa: E501 + updated_by (str, none_type): [optional] # noqa: E501 + created_by (str, none_type): [optional] # noqa: E501 + updated_at (datetime): [optional] # noqa: E501 + created_at (datetime): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/log.py b/src/apideck/model/log.py new file mode 100644 index 0000000000..df802e019c --- /dev/null +++ b/src/apideck/model/log.py @@ -0,0 +1,390 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.log_operation import LogOperation + from apideck.model.log_service import LogService + globals()['LogOperation'] = LogOperation + globals()['LogService'] = LogService + + +class Log(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('unified_api',): { + 'CRM': "crm", + 'LEAD': "lead", + 'PROXY': "proxy", + 'VAULT': "vault", + 'ACCOUNTING': "accounting", + 'HRIS': "hris", + 'ATS': "ats", + 'POS': "pos", + 'FILE-STORAGE': "file-storage", + 'SMS': "sms", + }, + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'api_style': (str,), # noqa: E501 + 'base_url': (str,), # noqa: E501 + 'child_request': (bool,), # noqa: E501 + 'consumer_id': (str,), # noqa: E501 + 'duration': (float,), # noqa: E501 + 'execution': (int,), # noqa: E501 + 'has_children': (bool,), # noqa: E501 + 'http_method': (str,), # noqa: E501 + 'id': (str,), # noqa: E501 + 'latency': (float,), # noqa: E501 + 'operation': (LogOperation,), # noqa: E501 + 'parent_id': (str, none_type,), # noqa: E501 + 'path': (str,), # noqa: E501 + 'sandbox': (bool,), # noqa: E501 + 'service': (LogService,), # noqa: E501 + 'status_code': (int,), # noqa: E501 + 'success': (bool,), # noqa: E501 + 'timestamp': (str,), # noqa: E501 + 'unified_api': (str,), # noqa: E501 + 'error_message': (str, none_type,), # noqa: E501 + 'source_ip': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'api_style': 'api_style', # noqa: E501 + 'base_url': 'base_url', # noqa: E501 + 'child_request': 'child_request', # noqa: E501 + 'consumer_id': 'consumer_id', # noqa: E501 + 'duration': 'duration', # noqa: E501 + 'execution': 'execution', # noqa: E501 + 'has_children': 'has_children', # noqa: E501 + 'http_method': 'http_method', # noqa: E501 + 'id': 'id', # noqa: E501 + 'latency': 'latency', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'parent_id': 'parent_id', # noqa: E501 + 'path': 'path', # noqa: E501 + 'sandbox': 'sandbox', # noqa: E501 + 'service': 'service', # noqa: E501 + 'status_code': 'status_code', # noqa: E501 + 'success': 'success', # noqa: E501 + 'timestamp': 'timestamp', # noqa: E501 + 'unified_api': 'unified_api', # noqa: E501 + 'error_message': 'error_message', # noqa: E501 + 'source_ip': 'source_ip', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, api_style, base_url, child_request, consumer_id, duration, execution, has_children, http_method, id, latency, operation, parent_id, path, sandbox, service, status_code, success, timestamp, unified_api, *args, **kwargs): # noqa: E501 + """Log - a model defined in OpenAPI + + Args: + api_style (str): Indicates if the request was made via REST or Graphql endpoint. + base_url (str): The Apideck base URL the request was made to. + child_request (bool): Indicates whether or not this is a child or parent request. + consumer_id (str): The consumer Id associated with the request. + duration (float): The entire execution time in milliseconds it took to call the Apideck service provider. + execution (int): The entire execution time in milliseconds it took to make the request. + has_children (bool): When request is a parent request, this indicates if there are child requests associated. + http_method (str): HTTP Method of request. + id (str): UUID acting as Request Identifier. + latency (float): Latency added by making this request via Unified Api. + operation (LogOperation): + parent_id (str, none_type): When request is a child request, this UUID indicates it's parent request. + path (str): The path component of the URI the request was made to. + sandbox (bool): Indicates whether the request was made using Apidecks sandbox credentials or not. + service (LogService): + status_code (int): HTTP Status code that was returned. + success (bool): Whether or not the request was successful. + timestamp (str): ISO Date and time when the request was made. + unified_api (str): Which Unified Api request was made to. + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + error_message (str, none_type): If error occurred, this is brief explanation. [optional] # noqa: E501 + source_ip (str, none_type): The IP address of the source of the request.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.api_style = api_style + self.base_url = base_url + self.child_request = child_request + self.consumer_id = consumer_id + self.duration = duration + self.execution = execution + self.has_children = has_children + self.http_method = http_method + self.id = id + self.latency = latency + self.operation = operation + self.parent_id = parent_id + self.path = path + self.sandbox = sandbox + self.service = service + self.status_code = status_code + self.success = success + self.timestamp = timestamp + self.unified_api = unified_api + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, api_style, base_url, child_request, consumer_id, duration, execution, has_children, http_method, id, latency, operation, parent_id, path, sandbox, service, status_code, success, timestamp, unified_api, *args, **kwargs): # noqa: E501 + """Log - a model defined in OpenAPI + + Args: + api_style (str): Indicates if the request was made via REST or Graphql endpoint. + base_url (str): The Apideck base URL the request was made to. + child_request (bool): Indicates whether or not this is a child or parent request. + consumer_id (str): The consumer Id associated with the request. + duration (float): The entire execution time in milliseconds it took to call the Apideck service provider. + execution (int): The entire execution time in milliseconds it took to make the request. + has_children (bool): When request is a parent request, this indicates if there are child requests associated. + http_method (str): HTTP Method of request. + id (str): UUID acting as Request Identifier. + latency (float): Latency added by making this request via Unified Api. + operation (LogOperation): + parent_id (str, none_type): When request is a child request, this UUID indicates it's parent request. + path (str): The path component of the URI the request was made to. + sandbox (bool): Indicates whether the request was made using Apidecks sandbox credentials or not. + service (LogService): + status_code (int): HTTP Status code that was returned. + success (bool): Whether or not the request was successful. + timestamp (str): ISO Date and time when the request was made. + unified_api (str): Which Unified Api request was made to. + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + error_message (str, none_type): If error occurred, this is brief explanation. [optional] # noqa: E501 + source_ip (str, none_type): The IP address of the source of the request.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.api_style = api_style + self.base_url = base_url + self.child_request = child_request + self.consumer_id = consumer_id + self.duration = duration + self.execution = execution + self.has_children = has_children + self.http_method = http_method + self.id = id + self.latency = latency + self.operation = operation + self.parent_id = parent_id + self.path = path + self.sandbox = sandbox + self.service = service + self.status_code = status_code + self.success = success + self.timestamp = timestamp + self.unified_api = unified_api + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/log_operation.py b/src/apideck/model/log_operation.py new file mode 100644 index 0000000000..eaa8327323 --- /dev/null +++ b/src/apideck/model/log_operation.py @@ -0,0 +1,267 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class LogOperation(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'id': (str,), # noqa: E501 + 'name': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'name': 'name', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, id, name, *args, **kwargs): # noqa: E501 + """LogOperation - a model defined in OpenAPI + + Args: + id (str): The OpenApi Operation Id associated with the request + name (str): The OpenApi Operation name associated with the request + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.id = id + self.name = name + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, id, name, *args, **kwargs): # noqa: E501 + """LogOperation - a model defined in OpenAPI + + Args: + id (str): The OpenApi Operation Id associated with the request + name (str): The OpenApi Operation name associated with the request + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.id = id + self.name = name + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/log_service.py b/src/apideck/model/log_service.py new file mode 100644 index 0000000000..7a4b9e2cb5 --- /dev/null +++ b/src/apideck/model/log_service.py @@ -0,0 +1,267 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class LogService(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'id': (str,), # noqa: E501 + 'name': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'name': 'name', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, id, name, *args, **kwargs): # noqa: E501 + """LogService - a model defined in OpenAPI + + Args: + id (str): Apideck service provider id. + name (str): Apideck service provider name. + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.id = id + self.name = name + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, id, name, *args, **kwargs): # noqa: E501 + """LogService - a model defined in OpenAPI + + Args: + id (str): Apideck service provider id. + name (str): Apideck service provider name. + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.id = id + self.name = name + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/logs_filter.py b/src/apideck/model/logs_filter.py new file mode 100644 index 0000000000..4801dcaaa3 --- /dev/null +++ b/src/apideck/model/logs_filter.py @@ -0,0 +1,263 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class LogsFilter(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'connector_id': (str, none_type,), # noqa: E501 + 'status_code': (float, none_type,), # noqa: E501 + 'exclude_unified_apis': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'connector_id': 'connector_id', # noqa: E501 + 'status_code': 'status_code', # noqa: E501 + 'exclude_unified_apis': 'exclude_unified_apis', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """LogsFilter - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + connector_id (str, none_type): [optional] # noqa: E501 + status_code (float, none_type): [optional] # noqa: E501 + exclude_unified_apis (str, none_type): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """LogsFilter - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + connector_id (str, none_type): [optional] # noqa: E501 + status_code (float, none_type): [optional] # noqa: E501 + exclude_unified_apis (str, none_type): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/merchant.py b/src/apideck/model/merchant.py new file mode 100644 index 0000000000..0e72755a7c --- /dev/null +++ b/src/apideck/model/merchant.py @@ -0,0 +1,317 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.address import Address + from apideck.model.currency import Currency + from apideck.model.service_charge import ServiceCharge + globals()['Address'] = Address + globals()['Currency'] = Currency + globals()['ServiceCharge'] = ServiceCharge + + +class Merchant(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('status',): { + 'None': None, + 'ACTIVE': "active", + 'INACTIVE': "inactive", + 'OTHER': "other", + }, + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'id': (str,), # noqa: E501 + 'name': (str, none_type,), # noqa: E501 + 'address': (Address,), # noqa: E501 + 'owner_id': (str,), # noqa: E501 + 'main_location_id': (str, none_type,), # noqa: E501 + 'status': (str, none_type,), # noqa: E501 + 'service_charges': ([ServiceCharge],), # noqa: E501 + 'language': (str, none_type,), # noqa: E501 + 'currency': (Currency,), # noqa: E501 + 'updated_by': (str, none_type,), # noqa: E501 + 'created_by': (str, none_type,), # noqa: E501 + 'updated_at': (datetime,), # noqa: E501 + 'created_at': (datetime,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'name': 'name', # noqa: E501 + 'address': 'address', # noqa: E501 + 'owner_id': 'owner_id', # noqa: E501 + 'main_location_id': 'main_location_id', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service_charges': 'service_charges', # noqa: E501 + 'language': 'language', # noqa: E501 + 'currency': 'currency', # noqa: E501 + 'updated_by': 'updated_by', # noqa: E501 + 'created_by': 'created_by', # noqa: E501 + 'updated_at': 'updated_at', # noqa: E501 + 'created_at': 'created_at', # noqa: E501 + } + + read_only_vars = { + 'id', # noqa: E501 + 'updated_by', # noqa: E501 + 'created_by', # noqa: E501 + 'updated_at', # noqa: E501 + 'created_at', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """Merchant - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + name (str, none_type): The name of the merchant. [optional] # noqa: E501 + address (Address): [optional] # noqa: E501 + owner_id (str): [optional] # noqa: E501 + main_location_id (str, none_type): The main location ID of the merchant. [optional] # noqa: E501 + status (str, none_type): Status of this merchant.. [optional] # noqa: E501 + service_charges ([ServiceCharge]): [optional] # noqa: E501 + language (str, none_type): language code according to ISO 639-1. For the United States - EN. [optional] # noqa: E501 + currency (Currency): [optional] # noqa: E501 + updated_by (str, none_type): [optional] # noqa: E501 + created_by (str, none_type): [optional] # noqa: E501 + updated_at (datetime): [optional] # noqa: E501 + created_at (datetime): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """Merchant - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + name (str, none_type): The name of the merchant. [optional] # noqa: E501 + address (Address): [optional] # noqa: E501 + owner_id (str): [optional] # noqa: E501 + main_location_id (str, none_type): The main location ID of the merchant. [optional] # noqa: E501 + status (str, none_type): Status of this merchant.. [optional] # noqa: E501 + service_charges ([ServiceCharge]): [optional] # noqa: E501 + language (str, none_type): language code according to ISO 639-1. For the United States - EN. [optional] # noqa: E501 + currency (Currency): [optional] # noqa: E501 + updated_by (str, none_type): [optional] # noqa: E501 + created_by (str, none_type): [optional] # noqa: E501 + updated_at (datetime): [optional] # noqa: E501 + created_at (datetime): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/message.py b/src/apideck/model/message.py new file mode 100644 index 0000000000..619de6bf46 --- /dev/null +++ b/src/apideck/model/message.py @@ -0,0 +1,384 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.error import Error + from apideck.model.price import Price + globals()['Error'] = Error + globals()['Price'] = Price + + +class Message(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('type',): { + 'SMS': "sms", + 'MMS': "mms", + }, + ('direction',): { + 'INBOUND': "inbound", + 'OUTBOUND-API': "outbound-api", + 'OUTBOUND-CALL': "outbound-call", + 'OUTBOUND-REPLY': "outbound-reply", + 'UNKNOWN': "unknown", + }, + ('status',): { + 'ACCEPTED': "accepted", + 'SCHEDULED': "scheduled", + 'CANCELED': "canceled", + 'QUEUED': "queued", + 'SENDING': "sending", + 'SENT': "sent", + 'FAILED': "failed", + 'DELIVERED': "delivered", + 'UNDELIVERED': "undelivered", + 'RECEIVING': "receiving", + 'RECEIVED': "received", + 'READ': "read", + }, + } + + validations = { + ('body',): { + 'max_length': 1600, + }, + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + '_from': (str,), # noqa: E501 + 'to': (str,), # noqa: E501 + 'body': (str,), # noqa: E501 + 'id': (str,), # noqa: E501 + 'subject': (str,), # noqa: E501 + 'type': (str,), # noqa: E501 + 'number_of_units': (int,), # noqa: E501 + 'number_of_media_files': (int,), # noqa: E501 + 'direction': (str,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'scheduled_at': (datetime,), # noqa: E501 + 'sent_at': (datetime,), # noqa: E501 + 'webhook_url': (str,), # noqa: E501 + 'reference': (str,), # noqa: E501 + 'price': (Price,), # noqa: E501 + 'error': (Error,), # noqa: E501 + 'messaging_service_id': (str,), # noqa: E501 + 'updated_by': (str, none_type,), # noqa: E501 + 'created_by': (str, none_type,), # noqa: E501 + 'updated_at': (datetime,), # noqa: E501 + 'created_at': (datetime,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + '_from': 'from', # noqa: E501 + 'to': 'to', # noqa: E501 + 'body': 'body', # noqa: E501 + 'id': 'id', # noqa: E501 + 'subject': 'subject', # noqa: E501 + 'type': 'type', # noqa: E501 + 'number_of_units': 'number_of_units', # noqa: E501 + 'number_of_media_files': 'number_of_media_files', # noqa: E501 + 'direction': 'direction', # noqa: E501 + 'status': 'status', # noqa: E501 + 'scheduled_at': 'scheduled_at', # noqa: E501 + 'sent_at': 'sent_at', # noqa: E501 + 'webhook_url': 'webhook_url', # noqa: E501 + 'reference': 'reference', # noqa: E501 + 'price': 'price', # noqa: E501 + 'error': 'error', # noqa: E501 + 'messaging_service_id': 'messaging_service_id', # noqa: E501 + 'updated_by': 'updated_by', # noqa: E501 + 'created_by': 'created_by', # noqa: E501 + 'updated_at': 'updated_at', # noqa: E501 + 'created_at': 'created_at', # noqa: E501 + } + + read_only_vars = { + 'id', # noqa: E501 + 'number_of_units', # noqa: E501 + 'number_of_media_files', # noqa: E501 + 'direction', # noqa: E501 + 'status', # noqa: E501 + 'sent_at', # noqa: E501 + 'updated_by', # noqa: E501 + 'created_by', # noqa: E501 + 'updated_at', # noqa: E501 + 'created_at', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, _from, to, body, *args, **kwargs): # noqa: E501 + """Message - a model defined in OpenAPI + + Args: + _from (str): The phone number that initiated the message. + to (str): The phone number that received the message. + body (str): The message text. + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + subject (str): [optional] # noqa: E501 + type (str): Set to sms for SMS messages and mms for MMS messages.. [optional] # noqa: E501 + number_of_units (int): The number of units that make up the complete message. Messages can be split up due to the constraints of the message size.. [optional] # noqa: E501 + number_of_media_files (int): The number of media files associated with the message.. [optional] # noqa: E501 + direction (str): The direction of the message.. [optional] # noqa: E501 + status (str): Status of the delivery of the message.. [optional] # noqa: E501 + scheduled_at (datetime): The scheduled date and time of the message.. [optional] # noqa: E501 + sent_at (datetime): The date and time that the message was sent. [optional] # noqa: E501 + webhook_url (str): Define a webhook to receive delivery notifications.. [optional] # noqa: E501 + reference (str): A client reference.. [optional] # noqa: E501 + price (Price): [optional] # noqa: E501 + error (Error): [optional] # noqa: E501 + messaging_service_id (str): The ID of the Messaging Service used with the message. In case of Plivo this links to the Powerpack ID.. [optional] # noqa: E501 + updated_by (str, none_type): [optional] # noqa: E501 + created_by (str, none_type): [optional] # noqa: E501 + updated_at (datetime): [optional] # noqa: E501 + created_at (datetime): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self._from = _from + self.to = to + self.body = body + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, _from, to, body, *args, **kwargs): # noqa: E501 + """Message - a model defined in OpenAPI + + Args: + _from (str): The phone number that initiated the message. + to (str): The phone number that received the message. + body (str): The message text. + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + subject (str): [optional] # noqa: E501 + type (str): Set to sms for SMS messages and mms for MMS messages.. [optional] # noqa: E501 + number_of_units (int): The number of units that make up the complete message. Messages can be split up due to the constraints of the message size.. [optional] # noqa: E501 + number_of_media_files (int): The number of media files associated with the message.. [optional] # noqa: E501 + direction (str): The direction of the message.. [optional] # noqa: E501 + status (str): Status of the delivery of the message.. [optional] # noqa: E501 + scheduled_at (datetime): The scheduled date and time of the message.. [optional] # noqa: E501 + sent_at (datetime): The date and time that the message was sent. [optional] # noqa: E501 + webhook_url (str): Define a webhook to receive delivery notifications.. [optional] # noqa: E501 + reference (str): A client reference.. [optional] # noqa: E501 + price (Price): [optional] # noqa: E501 + error (Error): [optional] # noqa: E501 + messaging_service_id (str): The ID of the Messaging Service used with the message. In case of Plivo this links to the Powerpack ID.. [optional] # noqa: E501 + updated_by (str, none_type): [optional] # noqa: E501 + created_by (str, none_type): [optional] # noqa: E501 + updated_at (datetime): [optional] # noqa: E501 + created_at (datetime): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self._from = _from + self.to = to + self.body = body + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/meta.py b/src/apideck/model/meta.py new file mode 100644 index 0000000000..2b6c723312 --- /dev/null +++ b/src/apideck/model/meta.py @@ -0,0 +1,265 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.meta_cursors import MetaCursors + globals()['MetaCursors'] = MetaCursors + + +class Meta(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'items_on_page': (int,), # noqa: E501 + 'cursors': (MetaCursors,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'items_on_page': 'items_on_page', # noqa: E501 + 'cursors': 'cursors', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """Meta - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + items_on_page (int): Number of items returned in the data property of the response. [optional] # noqa: E501 + cursors (MetaCursors): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """Meta - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + items_on_page (int): Number of items returned in the data property of the response. [optional] # noqa: E501 + cursors (MetaCursors): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/meta_cursors.py b/src/apideck/model/meta_cursors.py new file mode 100644 index 0000000000..babafcfedf --- /dev/null +++ b/src/apideck/model/meta_cursors.py @@ -0,0 +1,263 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class MetaCursors(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'previous': (str, none_type,), # noqa: E501 + 'current': (str, none_type,), # noqa: E501 + 'next': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'previous': 'previous', # noqa: E501 + 'current': 'current', # noqa: E501 + 'next': 'next', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """MetaCursors - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + previous (str, none_type): Cursor to navigate to the previous page of results through the API. [optional] # noqa: E501 + current (str, none_type): Cursor to navigate to the current page of results through the API. [optional] # noqa: E501 + next (str, none_type): Cursor to navigate to the next page of results through the API. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """MetaCursors - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + previous (str, none_type): Cursor to navigate to the previous page of results through the API. [optional] # noqa: E501 + current (str, none_type): Cursor to navigate to the current page of results through the API. [optional] # noqa: E501 + next (str, none_type): Cursor to navigate to the next page of results through the API. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/modifier.py b/src/apideck/model/modifier.py new file mode 100644 index 0000000000..1ac9de0960 --- /dev/null +++ b/src/apideck/model/modifier.py @@ -0,0 +1,313 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.currency import Currency + from apideck.model.idempotency_key import IdempotencyKey + globals()['Currency'] = Currency + globals()['IdempotencyKey'] = IdempotencyKey + + +class Modifier(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'name': (str,), # noqa: E501 + 'modifier_group_id': (str,), # noqa: E501 + 'id': (str,), # noqa: E501 + 'idempotency_key': (IdempotencyKey,), # noqa: E501 + 'alternate_name': (str,), # noqa: E501 + 'price_amount': (float,), # noqa: E501 + 'currency': (Currency,), # noqa: E501 + 'available': (bool, none_type,), # noqa: E501 + 'updated_by': (str, none_type,), # noqa: E501 + 'created_by': (str, none_type,), # noqa: E501 + 'updated_at': (datetime,), # noqa: E501 + 'created_at': (datetime,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'name': 'name', # noqa: E501 + 'modifier_group_id': 'modifier_group_id', # noqa: E501 + 'id': 'id', # noqa: E501 + 'idempotency_key': 'idempotency_key', # noqa: E501 + 'alternate_name': 'alternate_name', # noqa: E501 + 'price_amount': 'price_amount', # noqa: E501 + 'currency': 'currency', # noqa: E501 + 'available': 'available', # noqa: E501 + 'updated_by': 'updated_by', # noqa: E501 + 'created_by': 'created_by', # noqa: E501 + 'updated_at': 'updated_at', # noqa: E501 + 'created_at': 'created_at', # noqa: E501 + } + + read_only_vars = { + 'id', # noqa: E501 + 'updated_by', # noqa: E501 + 'created_by', # noqa: E501 + 'updated_at', # noqa: E501 + 'created_at', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, name, modifier_group_id, *args, **kwargs): # noqa: E501 + """Modifier - a model defined in OpenAPI + + Args: + name (str): + modifier_group_id (str): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + idempotency_key (IdempotencyKey): [optional] # noqa: E501 + alternate_name (str): [optional] # noqa: E501 + price_amount (float): [optional] # noqa: E501 + currency (Currency): [optional] # noqa: E501 + available (bool, none_type): [optional] # noqa: E501 + updated_by (str, none_type): [optional] # noqa: E501 + created_by (str, none_type): [optional] # noqa: E501 + updated_at (datetime): [optional] # noqa: E501 + created_at (datetime): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.name = name + self.modifier_group_id = modifier_group_id + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, name, modifier_group_id, *args, **kwargs): # noqa: E501 + """Modifier - a model defined in OpenAPI + + Args: + name (str): + modifier_group_id (str): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + idempotency_key (IdempotencyKey): [optional] # noqa: E501 + alternate_name (str): [optional] # noqa: E501 + price_amount (float): [optional] # noqa: E501 + currency (Currency): [optional] # noqa: E501 + available (bool, none_type): [optional] # noqa: E501 + updated_by (str, none_type): [optional] # noqa: E501 + created_by (str, none_type): [optional] # noqa: E501 + updated_at (datetime): [optional] # noqa: E501 + created_at (datetime): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.name = name + self.modifier_group_id = modifier_group_id + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/modifier_group.py b/src/apideck/model/modifier_group.py new file mode 100644 index 0000000000..9e898ed8a3 --- /dev/null +++ b/src/apideck/model/modifier_group.py @@ -0,0 +1,310 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class ModifierGroup(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('selection_type',): { + 'SINGLE': "single", + 'MULTIPLE': "multiple", + }, + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'id': (str,), # noqa: E501 + 'name': (str,), # noqa: E501 + 'alternate_name': (str,), # noqa: E501 + 'minimum_required': (int,), # noqa: E501 + 'maximum_allowed': (int,), # noqa: E501 + 'selection_type': (str,), # noqa: E501 + 'present_at_all_locations': (bool,), # noqa: E501 + 'modifiers': ([bool, date, datetime, dict, float, int, list, str, none_type],), # noqa: E501 + 'deleted': (bool, none_type,), # noqa: E501 + 'row_version': (str, none_type,), # noqa: E501 + 'updated_by': (str, none_type,), # noqa: E501 + 'created_by': (str, none_type,), # noqa: E501 + 'updated_at': (datetime,), # noqa: E501 + 'created_at': (datetime,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'name': 'name', # noqa: E501 + 'alternate_name': 'alternate_name', # noqa: E501 + 'minimum_required': 'minimum_required', # noqa: E501 + 'maximum_allowed': 'maximum_allowed', # noqa: E501 + 'selection_type': 'selection_type', # noqa: E501 + 'present_at_all_locations': 'present_at_all_locations', # noqa: E501 + 'modifiers': 'modifiers', # noqa: E501 + 'deleted': 'deleted', # noqa: E501 + 'row_version': 'row_version', # noqa: E501 + 'updated_by': 'updated_by', # noqa: E501 + 'created_by': 'created_by', # noqa: E501 + 'updated_at': 'updated_at', # noqa: E501 + 'created_at': 'created_at', # noqa: E501 + } + + read_only_vars = { + 'id', # noqa: E501 + 'updated_by', # noqa: E501 + 'created_by', # noqa: E501 + 'updated_at', # noqa: E501 + 'created_at', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ModifierGroup - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + name (str): [optional] # noqa: E501 + alternate_name (str): [optional] # noqa: E501 + minimum_required (int): [optional] # noqa: E501 + maximum_allowed (int): [optional] # noqa: E501 + selection_type (str): [optional] # noqa: E501 + present_at_all_locations (bool): [optional] # noqa: E501 + modifiers ([bool, date, datetime, dict, float, int, list, str, none_type]): [optional] # noqa: E501 + deleted (bool, none_type): [optional] # noqa: E501 + row_version (str, none_type): [optional] # noqa: E501 + updated_by (str, none_type): [optional] # noqa: E501 + created_by (str, none_type): [optional] # noqa: E501 + updated_at (datetime): [optional] # noqa: E501 + created_at (datetime): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """ModifierGroup - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + name (str): [optional] # noqa: E501 + alternate_name (str): [optional] # noqa: E501 + minimum_required (int): [optional] # noqa: E501 + maximum_allowed (int): [optional] # noqa: E501 + selection_type (str): [optional] # noqa: E501 + present_at_all_locations (bool): [optional] # noqa: E501 + modifiers ([bool, date, datetime, dict, float, int, list, str, none_type]): [optional] # noqa: E501 + deleted (bool, none_type): [optional] # noqa: E501 + row_version (str, none_type): [optional] # noqa: E501 + updated_by (str, none_type): [optional] # noqa: E501 + created_by (str, none_type): [optional] # noqa: E501 + updated_at (datetime): [optional] # noqa: E501 + created_at (datetime): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/modifier_group_filter.py b/src/apideck/model/modifier_group_filter.py new file mode 100644 index 0000000000..3b1288f733 --- /dev/null +++ b/src/apideck/model/modifier_group_filter.py @@ -0,0 +1,249 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class ModifierGroupFilter(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'modifier_group_id': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'modifier_group_id': 'modifier_group_id', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ModifierGroupFilter - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + modifier_group_id (str): Id of the job to filter on. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """ModifierGroupFilter - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + modifier_group_id (str): Id of the job to filter on. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/not_found_response.py b/src/apideck/model/not_found_response.py new file mode 100644 index 0000000000..31bd6583e2 --- /dev/null +++ b/src/apideck/model/not_found_response.py @@ -0,0 +1,275 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class NotFoundResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'status_code': (float,), # noqa: E501 + 'error': (str,), # noqa: E501 + 'type_name': (str,), # noqa: E501 + 'message': (str,), # noqa: E501 + 'detail': (bool, date, datetime, dict, float, int, list, str, none_type,), # noqa: E501 + 'ref': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'error': 'error', # noqa: E501 + 'type_name': 'type_name', # noqa: E501 + 'message': 'message', # noqa: E501 + 'detail': 'detail', # noqa: E501 + 'ref': 'ref', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """NotFoundResponse - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + status_code (float): HTTP status code. [optional] # noqa: E501 + error (str): Contains an explanation of the status_code as defined in HTTP/1.1 standard (RFC 7231). [optional] # noqa: E501 + type_name (str): The type of error returned. [optional] # noqa: E501 + message (str): A human-readable message providing more details about the error.. [optional] # noqa: E501 + detail (bool, date, datetime, dict, float, int, list, str, none_type): Contains parameter or domain specific information related to the error and why it occurred.. [optional] # noqa: E501 + ref (str): Link to documentation of error type. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """NotFoundResponse - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + status_code (float): HTTP status code. [optional] # noqa: E501 + error (str): Contains an explanation of the status_code as defined in HTTP/1.1 standard (RFC 7231). [optional] # noqa: E501 + type_name (str): The type of error returned. [optional] # noqa: E501 + message (str): A human-readable message providing more details about the error.. [optional] # noqa: E501 + detail (bool, date, datetime, dict, float, int, list, str, none_type): Contains parameter or domain specific information related to the error and why it occurred.. [optional] # noqa: E501 + ref (str): Link to documentation of error type. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/not_implemented_response.py b/src/apideck/model/not_implemented_response.py new file mode 100644 index 0000000000..102dd47d9b --- /dev/null +++ b/src/apideck/model/not_implemented_response.py @@ -0,0 +1,275 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class NotImplementedResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'status_code': (float,), # noqa: E501 + 'error': (str,), # noqa: E501 + 'type_name': (str,), # noqa: E501 + 'message': (str,), # noqa: E501 + 'detail': (bool, date, datetime, dict, float, int, list, str, none_type,), # noqa: E501 + 'ref': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'error': 'error', # noqa: E501 + 'type_name': 'type_name', # noqa: E501 + 'message': 'message', # noqa: E501 + 'detail': 'detail', # noqa: E501 + 'ref': 'ref', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """NotImplementedResponse - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + status_code (float): HTTP status code. [optional] # noqa: E501 + error (str): Contains an explanation of the status_code as defined in HTTP/1.1 standard (RFC 7231). [optional] # noqa: E501 + type_name (str): The type of error returned. [optional] # noqa: E501 + message (str): A human-readable message providing more details about the error.. [optional] # noqa: E501 + detail (bool, date, datetime, dict, float, int, list, str, none_type): Contains parameter or domain specific information related to the error and why it occurred.. [optional] # noqa: E501 + ref (str): Link to documentation of error type. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """NotImplementedResponse - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + status_code (float): HTTP status code. [optional] # noqa: E501 + error (str): Contains an explanation of the status_code as defined in HTTP/1.1 standard (RFC 7231). [optional] # noqa: E501 + type_name (str): The type of error returned. [optional] # noqa: E501 + message (str): A human-readable message providing more details about the error.. [optional] # noqa: E501 + detail (bool, date, datetime, dict, float, int, list, str, none_type): Contains parameter or domain specific information related to the error and why it occurred.. [optional] # noqa: E501 + ref (str): Link to documentation of error type. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/note.py b/src/apideck/model/note.py new file mode 100644 index 0000000000..a6951df60f --- /dev/null +++ b/src/apideck/model/note.py @@ -0,0 +1,302 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class Note(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'id': (str,), # noqa: E501 + 'title': (str,), # noqa: E501 + 'content': (str,), # noqa: E501 + 'owner_id': (str,), # noqa: E501 + 'contact_id': (str, none_type,), # noqa: E501 + 'company_id': (str, none_type,), # noqa: E501 + 'opportunity_id': (str, none_type,), # noqa: E501 + 'lead_id': (str, none_type,), # noqa: E501 + 'active': (bool, none_type,), # noqa: E501 + 'updated_by': (str, none_type,), # noqa: E501 + 'created_by': (str, none_type,), # noqa: E501 + 'updated_at': (str,), # noqa: E501 + 'created_at': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'title': 'title', # noqa: E501 + 'content': 'content', # noqa: E501 + 'owner_id': 'owner_id', # noqa: E501 + 'contact_id': 'contact_id', # noqa: E501 + 'company_id': 'company_id', # noqa: E501 + 'opportunity_id': 'opportunity_id', # noqa: E501 + 'lead_id': 'lead_id', # noqa: E501 + 'active': 'active', # noqa: E501 + 'updated_by': 'updated_by', # noqa: E501 + 'created_by': 'created_by', # noqa: E501 + 'updated_at': 'updated_at', # noqa: E501 + 'created_at': 'created_at', # noqa: E501 + } + + read_only_vars = { + 'id', # noqa: E501 + 'updated_by', # noqa: E501 + 'created_by', # noqa: E501 + 'updated_at', # noqa: E501 + 'created_at', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """Note - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + title (str): [optional] # noqa: E501 + content (str): [optional] # noqa: E501 + owner_id (str): [optional] # noqa: E501 + contact_id (str, none_type): [optional] # noqa: E501 + company_id (str, none_type): [optional] # noqa: E501 + opportunity_id (str, none_type): [optional] # noqa: E501 + lead_id (str, none_type): [optional] # noqa: E501 + active (bool, none_type): [optional] # noqa: E501 + updated_by (str, none_type): [optional] # noqa: E501 + created_by (str, none_type): [optional] # noqa: E501 + updated_at (str): [optional] # noqa: E501 + created_at (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """Note - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + title (str): [optional] # noqa: E501 + content (str): [optional] # noqa: E501 + owner_id (str): [optional] # noqa: E501 + contact_id (str, none_type): [optional] # noqa: E501 + company_id (str, none_type): [optional] # noqa: E501 + opportunity_id (str, none_type): [optional] # noqa: E501 + lead_id (str, none_type): [optional] # noqa: E501 + active (bool, none_type): [optional] # noqa: E501 + updated_by (str, none_type): [optional] # noqa: E501 + created_by (str, none_type): [optional] # noqa: E501 + updated_at (str): [optional] # noqa: E501 + created_at (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/o_auth_grant_type.py b/src/apideck/model/o_auth_grant_type.py new file mode 100644 index 0000000000..76c120a9cc --- /dev/null +++ b/src/apideck/model/o_auth_grant_type.py @@ -0,0 +1,283 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class OAuthGrantType(ModelSimple): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('value',): { + 'AUTHORIZATION_CODE': "authorization_code", + 'CLIENT_CREDENTIALS': "client_credentials", + 'PASSWORD': "password", + }, + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'value': (str,), + } + + @cached_property + def discriminator(): + return None + + + attribute_map = {} + + read_only_vars = set() + + _composed_schemas = None + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): + """OAuthGrantType - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] (str): OAuth grant type used by the connector. More info: https://oauth.net/2/grant-types., must be one of ["authorization_code", "client_credentials", "password", ] # noqa: E501 + + Keyword Args: + value (str): OAuth grant type used by the connector. More info: https://oauth.net/2/grant-types., must be one of ["authorization_code", "client_credentials", "password", ] # noqa: E501 + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + self.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): + """OAuthGrantType - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] (str): OAuth grant type used by the connector. More info: https://oauth.net/2/grant-types., must be one of ["authorization_code", "client_credentials", "password", ] # noqa: E501 + + Keyword Args: + value (str): OAuth grant type used by the connector. More info: https://oauth.net/2/grant-types., must be one of ["authorization_code", "client_credentials", "password", ] # noqa: E501 + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + self.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + return self diff --git a/src/apideck/model/offer.py b/src/apideck/model/offer.py new file mode 100644 index 0000000000..51f63dc1c8 --- /dev/null +++ b/src/apideck/model/offer.py @@ -0,0 +1,274 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class Offer(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'id': (str,), # noqa: E501 + 'application_id': (str,), # noqa: E501 + 'updated_by': (str, none_type,), # noqa: E501 + 'created_by': (str, none_type,), # noqa: E501 + 'updated_at': (datetime,), # noqa: E501 + 'created_at': (datetime,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'application_id': 'application_id', # noqa: E501 + 'updated_by': 'updated_by', # noqa: E501 + 'created_by': 'created_by', # noqa: E501 + 'updated_at': 'updated_at', # noqa: E501 + 'created_at': 'created_at', # noqa: E501 + } + + read_only_vars = { + 'id', # noqa: E501 + 'updated_by', # noqa: E501 + 'created_by', # noqa: E501 + 'updated_at', # noqa: E501 + 'created_at', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """Offer - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + application_id (str): [optional] # noqa: E501 + updated_by (str, none_type): [optional] # noqa: E501 + created_by (str, none_type): [optional] # noqa: E501 + updated_at (datetime): [optional] # noqa: E501 + created_at (datetime): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """Offer - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + application_id (str): [optional] # noqa: E501 + updated_by (str, none_type): [optional] # noqa: E501 + created_by (str, none_type): [optional] # noqa: E501 + updated_at (datetime): [optional] # noqa: E501 + created_at (datetime): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/opportunities_filter.py b/src/apideck/model/opportunities_filter.py new file mode 100644 index 0000000000..5400e606e2 --- /dev/null +++ b/src/apideck/model/opportunities_filter.py @@ -0,0 +1,265 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class OpportunitiesFilter(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'title': (str,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'monetary_amount': (float,), # noqa: E501 + 'win_probability': (float,), # noqa: E501 + 'company_id': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'title': 'title', # noqa: E501 + 'status': 'status', # noqa: E501 + 'monetary_amount': 'monetary_amount', # noqa: E501 + 'win_probability': 'win_probability', # noqa: E501 + 'company_id': 'company_id', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """OpportunitiesFilter - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + title (str): Title of the opportunity to filter on. [optional] # noqa: E501 + status (str): Status to filter on. [optional] # noqa: E501 + monetary_amount (float): Monetary amount to filter on. [optional] # noqa: E501 + win_probability (float): Win probability to filter on. [optional] # noqa: E501 + company_id (str): Company ID to filter on. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """OpportunitiesFilter - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + title (str): Title of the opportunity to filter on. [optional] # noqa: E501 + status (str): Status to filter on. [optional] # noqa: E501 + monetary_amount (float): Monetary amount to filter on. [optional] # noqa: E501 + win_probability (float): Win probability to filter on. [optional] # noqa: E501 + company_id (str): Company ID to filter on. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/opportunities_sort.py b/src/apideck/model/opportunities_sort.py new file mode 100644 index 0000000000..1b8884eba2 --- /dev/null +++ b/src/apideck/model/opportunities_sort.py @@ -0,0 +1,266 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.sort_direction import SortDirection + globals()['SortDirection'] = SortDirection + + +class OpportunitiesSort(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('by',): { + 'CREATED_AT': "created_at", + 'UPDATED_AT': "updated_at", + 'TITLE': "title", + 'WIN_PROBABILITY': "win_probability", + 'MONETARY_AMOUNT': "monetary_amount", + 'STATUS': "status", + }, + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'by': (str,), # noqa: E501 + 'direction': (SortDirection,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'by': 'by', # noqa: E501 + 'direction': 'direction', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """OpportunitiesSort - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + by (str): The field on which to sort the Opportunities. [optional] # noqa: E501 + direction (SortDirection): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """OpportunitiesSort - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + by (str): The field on which to sort the Opportunities. [optional] # noqa: E501 + direction (SortDirection): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/opportunity.py b/src/apideck/model/opportunity.py new file mode 100644 index 0000000000..16f38969f0 --- /dev/null +++ b/src/apideck/model/opportunity.py @@ -0,0 +1,433 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.currency import Currency + from apideck.model.custom_field import CustomField + from apideck.model.tags import Tags + globals()['Currency'] = Currency + globals()['CustomField'] = CustomField + globals()['Tags'] = Tags + + +class Opportunity(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + ('title',): { + 'min_length': 1, + }, + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'title': (str,), # noqa: E501 + 'primary_contact_id': (str, none_type,), # noqa: E501 + 'id': (str,), # noqa: E501 + 'description': (str, none_type,), # noqa: E501 + 'type': (str, none_type,), # noqa: E501 + 'monetary_amount': (float, none_type,), # noqa: E501 + 'currency': (Currency,), # noqa: E501 + 'win_probability': (float, none_type,), # noqa: E501 + 'expected_revenue': (float, none_type,), # noqa: E501 + 'close_date': (date, none_type,), # noqa: E501 + 'loss_reason_id': (str, none_type,), # noqa: E501 + 'loss_reason': (str, none_type,), # noqa: E501 + 'won_reason_id': (str, none_type,), # noqa: E501 + 'won_reason': (str, none_type,), # noqa: E501 + 'pipeline_id': (str, none_type,), # noqa: E501 + 'pipeline_stage_id': (str, none_type,), # noqa: E501 + 'source_id': (str, none_type,), # noqa: E501 + 'lead_id': (str, none_type,), # noqa: E501 + 'lead_source': (str, none_type,), # noqa: E501 + 'contact_id': (str, none_type,), # noqa: E501 + 'company_id': (str, none_type,), # noqa: E501 + 'company_name': (str, none_type,), # noqa: E501 + 'owner_id': (str, none_type,), # noqa: E501 + 'priority': (str, none_type,), # noqa: E501 + 'status': (str, none_type,), # noqa: E501 + 'status_id': (str, none_type,), # noqa: E501 + 'tags': (Tags,), # noqa: E501 + 'interaction_count': (float, none_type,), # noqa: E501 + 'custom_fields': ([CustomField],), # noqa: E501 + 'stage_last_changed_at': (datetime, none_type,), # noqa: E501 + 'last_activity_at': (str, none_type,), # noqa: E501 + 'deleted': (bool,), # noqa: E501 + 'date_stage_changed': (datetime, none_type,), # noqa: E501 + 'date_last_contacted': (datetime, none_type,), # noqa: E501 + 'date_lead_created': (datetime, none_type,), # noqa: E501 + 'updated_by': (str, none_type,), # noqa: E501 + 'created_by': (str, none_type,), # noqa: E501 + 'updated_at': (datetime,), # noqa: E501 + 'created_at': (datetime,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'title': 'title', # noqa: E501 + 'primary_contact_id': 'primary_contact_id', # noqa: E501 + 'id': 'id', # noqa: E501 + 'description': 'description', # noqa: E501 + 'type': 'type', # noqa: E501 + 'monetary_amount': 'monetary_amount', # noqa: E501 + 'currency': 'currency', # noqa: E501 + 'win_probability': 'win_probability', # noqa: E501 + 'expected_revenue': 'expected_revenue', # noqa: E501 + 'close_date': 'close_date', # noqa: E501 + 'loss_reason_id': 'loss_reason_id', # noqa: E501 + 'loss_reason': 'loss_reason', # noqa: E501 + 'won_reason_id': 'won_reason_id', # noqa: E501 + 'won_reason': 'won_reason', # noqa: E501 + 'pipeline_id': 'pipeline_id', # noqa: E501 + 'pipeline_stage_id': 'pipeline_stage_id', # noqa: E501 + 'source_id': 'source_id', # noqa: E501 + 'lead_id': 'lead_id', # noqa: E501 + 'lead_source': 'lead_source', # noqa: E501 + 'contact_id': 'contact_id', # noqa: E501 + 'company_id': 'company_id', # noqa: E501 + 'company_name': 'company_name', # noqa: E501 + 'owner_id': 'owner_id', # noqa: E501 + 'priority': 'priority', # noqa: E501 + 'status': 'status', # noqa: E501 + 'status_id': 'status_id', # noqa: E501 + 'tags': 'tags', # noqa: E501 + 'interaction_count': 'interaction_count', # noqa: E501 + 'custom_fields': 'custom_fields', # noqa: E501 + 'stage_last_changed_at': 'stage_last_changed_at', # noqa: E501 + 'last_activity_at': 'last_activity_at', # noqa: E501 + 'deleted': 'deleted', # noqa: E501 + 'date_stage_changed': 'date_stage_changed', # noqa: E501 + 'date_last_contacted': 'date_last_contacted', # noqa: E501 + 'date_lead_created': 'date_lead_created', # noqa: E501 + 'updated_by': 'updated_by', # noqa: E501 + 'created_by': 'created_by', # noqa: E501 + 'updated_at': 'updated_at', # noqa: E501 + 'created_at': 'created_at', # noqa: E501 + } + + read_only_vars = { + 'id', # noqa: E501 + 'expected_revenue', # noqa: E501 + 'interaction_count', # noqa: E501 + 'last_activity_at', # noqa: E501 + 'deleted', # noqa: E501 + 'date_stage_changed', # noqa: E501 + 'date_last_contacted', # noqa: E501 + 'date_lead_created', # noqa: E501 + 'updated_by', # noqa: E501 + 'created_by', # noqa: E501 + 'updated_at', # noqa: E501 + 'created_at', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, title, primary_contact_id, *args, **kwargs): # noqa: E501 + """Opportunity - a model defined in OpenAPI + + Args: + title (str): + primary_contact_id (str, none_type): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + description (str, none_type): [optional] # noqa: E501 + type (str, none_type): [optional] # noqa: E501 + monetary_amount (float, none_type): [optional] # noqa: E501 + currency (Currency): [optional] # noqa: E501 + win_probability (float, none_type): [optional] # noqa: E501 + expected_revenue (float, none_type): Expected Revenue. [optional] # noqa: E501 + close_date (date, none_type): [optional] # noqa: E501 + loss_reason_id (str, none_type): [optional] # noqa: E501 + loss_reason (str, none_type): [optional] # noqa: E501 + won_reason_id (str, none_type): [optional] # noqa: E501 + won_reason (str, none_type): [optional] # noqa: E501 + pipeline_id (str, none_type): [optional] # noqa: E501 + pipeline_stage_id (str, none_type): [optional] # noqa: E501 + source_id (str, none_type): [optional] # noqa: E501 + lead_id (str, none_type): [optional] # noqa: E501 + lead_source (str, none_type): Lead source. [optional] # noqa: E501 + contact_id (str, none_type): [optional] # noqa: E501 + company_id (str, none_type): [optional] # noqa: E501 + company_name (str, none_type): [optional] # noqa: E501 + owner_id (str, none_type): [optional] # noqa: E501 + priority (str, none_type): [optional] # noqa: E501 + status (str, none_type): [optional] # noqa: E501 + status_id (str, none_type): [optional] # noqa: E501 + tags (Tags): [optional] # noqa: E501 + interaction_count (float, none_type): [optional] # noqa: E501 + custom_fields ([CustomField]): [optional] # noqa: E501 + stage_last_changed_at (datetime, none_type): [optional] # noqa: E501 + last_activity_at (str, none_type): [optional] # noqa: E501 + deleted (bool): [optional] # noqa: E501 + date_stage_changed (datetime, none_type): [optional] # noqa: E501 + date_last_contacted (datetime, none_type): [optional] # noqa: E501 + date_lead_created (datetime, none_type): [optional] # noqa: E501 + updated_by (str, none_type): [optional] # noqa: E501 + created_by (str, none_type): [optional] # noqa: E501 + updated_at (datetime): [optional] # noqa: E501 + created_at (datetime): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.title = title + self.primary_contact_id = primary_contact_id + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, title, primary_contact_id, *args, **kwargs): # noqa: E501 + """Opportunity - a model defined in OpenAPI + + Args: + title (str): + primary_contact_id (str, none_type): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + description (str, none_type): [optional] # noqa: E501 + type (str, none_type): [optional] # noqa: E501 + monetary_amount (float, none_type): [optional] # noqa: E501 + currency (Currency): [optional] # noqa: E501 + win_probability (float, none_type): [optional] # noqa: E501 + expected_revenue (float, none_type): Expected Revenue. [optional] # noqa: E501 + close_date (date, none_type): [optional] # noqa: E501 + loss_reason_id (str, none_type): [optional] # noqa: E501 + loss_reason (str, none_type): [optional] # noqa: E501 + won_reason_id (str, none_type): [optional] # noqa: E501 + won_reason (str, none_type): [optional] # noqa: E501 + pipeline_id (str, none_type): [optional] # noqa: E501 + pipeline_stage_id (str, none_type): [optional] # noqa: E501 + source_id (str, none_type): [optional] # noqa: E501 + lead_id (str, none_type): [optional] # noqa: E501 + lead_source (str, none_type): Lead source. [optional] # noqa: E501 + contact_id (str, none_type): [optional] # noqa: E501 + company_id (str, none_type): [optional] # noqa: E501 + company_name (str, none_type): [optional] # noqa: E501 + owner_id (str, none_type): [optional] # noqa: E501 + priority (str, none_type): [optional] # noqa: E501 + status (str, none_type): [optional] # noqa: E501 + status_id (str, none_type): [optional] # noqa: E501 + tags (Tags): [optional] # noqa: E501 + interaction_count (float, none_type): [optional] # noqa: E501 + custom_fields ([CustomField]): [optional] # noqa: E501 + stage_last_changed_at (datetime, none_type): [optional] # noqa: E501 + last_activity_at (str, none_type): [optional] # noqa: E501 + deleted (bool): [optional] # noqa: E501 + date_stage_changed (datetime, none_type): [optional] # noqa: E501 + date_last_contacted (datetime, none_type): [optional] # noqa: E501 + date_lead_created (datetime, none_type): [optional] # noqa: E501 + updated_by (str, none_type): [optional] # noqa: E501 + created_by (str, none_type): [optional] # noqa: E501 + updated_at (datetime): [optional] # noqa: E501 + created_at (datetime): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.title = title + self.primary_contact_id = primary_contact_id + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/order.py b/src/apideck/model/order.py new file mode 100644 index 0000000000..94af9cec4b --- /dev/null +++ b/src/apideck/model/order.py @@ -0,0 +1,480 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.currency import Currency + from apideck.model.idempotency_key import IdempotencyKey + from apideck.model.order_customers import OrderCustomers + from apideck.model.order_discounts import OrderDiscounts + from apideck.model.order_fulfillments import OrderFulfillments + from apideck.model.order_line_items import OrderLineItems + from apideck.model.order_payments import OrderPayments + from apideck.model.order_refunds import OrderRefunds + from apideck.model.order_tenders import OrderTenders + from apideck.model.service_charges import ServiceCharges + globals()['Currency'] = Currency + globals()['IdempotencyKey'] = IdempotencyKey + globals()['OrderCustomers'] = OrderCustomers + globals()['OrderDiscounts'] = OrderDiscounts + globals()['OrderFulfillments'] = OrderFulfillments + globals()['OrderLineItems'] = OrderLineItems + globals()['OrderPayments'] = OrderPayments + globals()['OrderRefunds'] = OrderRefunds + globals()['OrderTenders'] = OrderTenders + globals()['ServiceCharges'] = ServiceCharges + + +class Order(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('status',): { + 'OPEN': "open", + 'DRAFT': "draft", + 'DELIVERED': "delivered", + 'DELAYED': "delayed", + 'VOIDED': "voided", + 'COMPLETED': "completed", + 'HIDDEN': "hidden", + }, + ('payment_status',): { + 'OPEN': "open", + 'PAID': "paid", + 'REFUNDED': "refunded", + 'CREDITED': "credited", + 'PARTIALLY_PAID': "partially_paid", + 'PARTIALLY_REFUNDED': "partially_refunded", + 'UNKNOWN': "unknown", + }, + ('source',): { + 'None': None, + 'IN-STORE': "in-store", + 'ONLINE': "online", + 'OPT': "opt", + 'API': "api", + 'KIOSK': "kiosk", + 'CALLER-ID': "caller-id", + 'GOOGLE': "google", + 'INVOICE': "invoice", + }, + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'merchant_id': (str,), # noqa: E501 + 'location_id': (str,), # noqa: E501 + 'id': (str,), # noqa: E501 + 'idempotency_key': (IdempotencyKey,), # noqa: E501 + 'order_number': (str,), # noqa: E501 + 'order_date': (date, none_type,), # noqa: E501 + 'closed_date': (date, none_type,), # noqa: E501 + 'reference_id': (str, none_type,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'payment_status': (str,), # noqa: E501 + 'currency': (Currency,), # noqa: E501 + 'title': (str,), # noqa: E501 + 'note': (str,), # noqa: E501 + 'customer_id': (str,), # noqa: E501 + 'employee_id': (str,), # noqa: E501 + 'order_type_id': (str,), # noqa: E501 + 'table': (str,), # noqa: E501 + 'seat': (str,), # noqa: E501 + 'total_amount': (int, none_type,), # noqa: E501 + 'total_tip': (int, none_type,), # noqa: E501 + 'total_tax': (int, none_type,), # noqa: E501 + 'total_discount': (int, none_type,), # noqa: E501 + 'total_refund': (int, none_type,), # noqa: E501 + 'total_service_charge': (int, none_type,), # noqa: E501 + 'refunded': (bool,), # noqa: E501 + 'customers': ([OrderCustomers],), # noqa: E501 + 'fulfillments': ([OrderFulfillments],), # noqa: E501 + 'line_items': ([OrderLineItems],), # noqa: E501 + 'payments': ([OrderPayments],), # noqa: E501 + 'service_charges': (ServiceCharges,), # noqa: E501 + 'refunds': ([OrderRefunds],), # noqa: E501 + 'taxes': ([bool, date, datetime, dict, float, int, list, str, none_type],), # noqa: E501 + 'discounts': ([OrderDiscounts],), # noqa: E501 + 'tenders': ([OrderTenders],), # noqa: E501 + 'source': (str, none_type,), # noqa: E501 + 'voided': (bool,), # noqa: E501 + 'voided_at': (datetime,), # noqa: E501 + 'version': (str, none_type,), # noqa: E501 + 'updated_by': (str, none_type,), # noqa: E501 + 'created_by': (str, none_type,), # noqa: E501 + 'updated_at': (datetime,), # noqa: E501 + 'created_at': (datetime,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'merchant_id': 'merchant_id', # noqa: E501 + 'location_id': 'location_id', # noqa: E501 + 'id': 'id', # noqa: E501 + 'idempotency_key': 'idempotency_key', # noqa: E501 + 'order_number': 'order_number', # noqa: E501 + 'order_date': 'order_date', # noqa: E501 + 'closed_date': 'closed_date', # noqa: E501 + 'reference_id': 'reference_id', # noqa: E501 + 'status': 'status', # noqa: E501 + 'payment_status': 'payment_status', # noqa: E501 + 'currency': 'currency', # noqa: E501 + 'title': 'title', # noqa: E501 + 'note': 'note', # noqa: E501 + 'customer_id': 'customer_id', # noqa: E501 + 'employee_id': 'employee_id', # noqa: E501 + 'order_type_id': 'order_type_id', # noqa: E501 + 'table': 'table', # noqa: E501 + 'seat': 'seat', # noqa: E501 + 'total_amount': 'total_amount', # noqa: E501 + 'total_tip': 'total_tip', # noqa: E501 + 'total_tax': 'total_tax', # noqa: E501 + 'total_discount': 'total_discount', # noqa: E501 + 'total_refund': 'total_refund', # noqa: E501 + 'total_service_charge': 'total_service_charge', # noqa: E501 + 'refunded': 'refunded', # noqa: E501 + 'customers': 'customers', # noqa: E501 + 'fulfillments': 'fulfillments', # noqa: E501 + 'line_items': 'line_items', # noqa: E501 + 'payments': 'payments', # noqa: E501 + 'service_charges': 'service_charges', # noqa: E501 + 'refunds': 'refunds', # noqa: E501 + 'taxes': 'taxes', # noqa: E501 + 'discounts': 'discounts', # noqa: E501 + 'tenders': 'tenders', # noqa: E501 + 'source': 'source', # noqa: E501 + 'voided': 'voided', # noqa: E501 + 'voided_at': 'voided_at', # noqa: E501 + 'version': 'version', # noqa: E501 + 'updated_by': 'updated_by', # noqa: E501 + 'created_by': 'created_by', # noqa: E501 + 'updated_at': 'updated_at', # noqa: E501 + 'created_at': 'created_at', # noqa: E501 + } + + read_only_vars = { + 'id', # noqa: E501 + 'source', # noqa: E501 + 'voided_at', # noqa: E501 + 'updated_by', # noqa: E501 + 'created_by', # noqa: E501 + 'updated_at', # noqa: E501 + 'created_at', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, merchant_id, location_id, *args, **kwargs): # noqa: E501 + """Order - a model defined in OpenAPI + + Args: + merchant_id (str): + location_id (str): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + idempotency_key (IdempotencyKey): [optional] # noqa: E501 + order_number (str): [optional] # noqa: E501 + order_date (date, none_type): [optional] # noqa: E501 + closed_date (date, none_type): [optional] # noqa: E501 + reference_id (str, none_type): An optional user-defined reference ID that associates this record with another entity in an external system. For example, a customer ID from an external customer management system.. [optional] # noqa: E501 + status (str): Order status. Clover specific: If no value is set, the status defaults to hidden, which indicates a hidden order. A hidden order is not displayed in user interfaces and can only be retrieved by its id. When creating an order via the REST API the value must be manually set to 'open'. More info [https://docs.clover.com/reference/orderupdateorder](). [optional] # noqa: E501 + payment_status (str): Is this order paid or not?. [optional] # noqa: E501 + currency (Currency): [optional] # noqa: E501 + title (str): [optional] # noqa: E501 + note (str): A note with information about this order, may be printed on the order receipt and displayed in apps. [optional] # noqa: E501 + customer_id (str): [optional] # noqa: E501 + employee_id (str): [optional] # noqa: E501 + order_type_id (str): [optional] # noqa: E501 + table (str): [optional] # noqa: E501 + seat (str): [optional] # noqa: E501 + total_amount (int, none_type): [optional] # noqa: E501 + total_tip (int, none_type): [optional] # noqa: E501 + total_tax (int, none_type): [optional] # noqa: E501 + total_discount (int, none_type): [optional] # noqa: E501 + total_refund (int, none_type): [optional] # noqa: E501 + total_service_charge (int, none_type): [optional] # noqa: E501 + refunded (bool): [optional] # noqa: E501 + customers ([OrderCustomers]): [optional] # noqa: E501 + fulfillments ([OrderFulfillments]): [optional] # noqa: E501 + line_items ([OrderLineItems]): [optional] # noqa: E501 + payments ([OrderPayments]): [optional] # noqa: E501 + service_charges (ServiceCharges): [optional] # noqa: E501 + refunds ([OrderRefunds]): [optional] # noqa: E501 + taxes ([bool, date, datetime, dict, float, int, list, str, none_type]): [optional] # noqa: E501 + discounts ([OrderDiscounts]): [optional] # noqa: E501 + tenders ([OrderTenders]): [optional] # noqa: E501 + source (str, none_type): Source of order. Indicates the way that the order was placed.. [optional] # noqa: E501 + voided (bool): [optional] # noqa: E501 + voided_at (datetime): [optional] # noqa: E501 + version (str, none_type): [optional] # noqa: E501 + updated_by (str, none_type): [optional] # noqa: E501 + created_by (str, none_type): [optional] # noqa: E501 + updated_at (datetime): [optional] # noqa: E501 + created_at (datetime): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.merchant_id = merchant_id + self.location_id = location_id + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, merchant_id, location_id, *args, **kwargs): # noqa: E501 + """Order - a model defined in OpenAPI + + Args: + merchant_id (str): + location_id (str): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + idempotency_key (IdempotencyKey): [optional] # noqa: E501 + order_number (str): [optional] # noqa: E501 + order_date (date, none_type): [optional] # noqa: E501 + closed_date (date, none_type): [optional] # noqa: E501 + reference_id (str, none_type): An optional user-defined reference ID that associates this record with another entity in an external system. For example, a customer ID from an external customer management system.. [optional] # noqa: E501 + status (str): Order status. Clover specific: If no value is set, the status defaults to hidden, which indicates a hidden order. A hidden order is not displayed in user interfaces and can only be retrieved by its id. When creating an order via the REST API the value must be manually set to 'open'. More info [https://docs.clover.com/reference/orderupdateorder](). [optional] # noqa: E501 + payment_status (str): Is this order paid or not?. [optional] # noqa: E501 + currency (Currency): [optional] # noqa: E501 + title (str): [optional] # noqa: E501 + note (str): A note with information about this order, may be printed on the order receipt and displayed in apps. [optional] # noqa: E501 + customer_id (str): [optional] # noqa: E501 + employee_id (str): [optional] # noqa: E501 + order_type_id (str): [optional] # noqa: E501 + table (str): [optional] # noqa: E501 + seat (str): [optional] # noqa: E501 + total_amount (int, none_type): [optional] # noqa: E501 + total_tip (int, none_type): [optional] # noqa: E501 + total_tax (int, none_type): [optional] # noqa: E501 + total_discount (int, none_type): [optional] # noqa: E501 + total_refund (int, none_type): [optional] # noqa: E501 + total_service_charge (int, none_type): [optional] # noqa: E501 + refunded (bool): [optional] # noqa: E501 + customers ([OrderCustomers]): [optional] # noqa: E501 + fulfillments ([OrderFulfillments]): [optional] # noqa: E501 + line_items ([OrderLineItems]): [optional] # noqa: E501 + payments ([OrderPayments]): [optional] # noqa: E501 + service_charges (ServiceCharges): [optional] # noqa: E501 + refunds ([OrderRefunds]): [optional] # noqa: E501 + taxes ([bool, date, datetime, dict, float, int, list, str, none_type]): [optional] # noqa: E501 + discounts ([OrderDiscounts]): [optional] # noqa: E501 + tenders ([OrderTenders]): [optional] # noqa: E501 + source (str, none_type): Source of order. Indicates the way that the order was placed.. [optional] # noqa: E501 + voided (bool): [optional] # noqa: E501 + voided_at (datetime): [optional] # noqa: E501 + version (str, none_type): [optional] # noqa: E501 + updated_by (str, none_type): [optional] # noqa: E501 + created_by (str, none_type): [optional] # noqa: E501 + updated_at (datetime): [optional] # noqa: E501 + created_at (datetime): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.merchant_id = merchant_id + self.location_id = location_id + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/order_customers.py b/src/apideck/model/order_customers.py new file mode 100644 index 0000000000..e7b4e4eb01 --- /dev/null +++ b/src/apideck/model/order_customers.py @@ -0,0 +1,279 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.email import Email + from apideck.model.phone_number import PhoneNumber + globals()['Email'] = Email + globals()['PhoneNumber'] = PhoneNumber + + +class OrderCustomers(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'first_name': (str, none_type,), # noqa: E501 + 'middle_name': (str, none_type,), # noqa: E501 + 'last_name': (str, none_type,), # noqa: E501 + 'phone_numbers': ([PhoneNumber],), # noqa: E501 + 'emails': ([Email],), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'first_name': 'first_name', # noqa: E501 + 'middle_name': 'middle_name', # noqa: E501 + 'last_name': 'last_name', # noqa: E501 + 'phone_numbers': 'phone_numbers', # noqa: E501 + 'emails': 'emails', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """OrderCustomers - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + first_name (str, none_type): [optional] # noqa: E501 + middle_name (str, none_type): [optional] # noqa: E501 + last_name (str, none_type): [optional] # noqa: E501 + phone_numbers ([PhoneNumber]): [optional] # noqa: E501 + emails ([Email]): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """OrderCustomers - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + first_name (str, none_type): [optional] # noqa: E501 + middle_name (str, none_type): [optional] # noqa: E501 + last_name (str, none_type): [optional] # noqa: E501 + phone_numbers ([PhoneNumber]): [optional] # noqa: E501 + emails ([Email]): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/order_discounts.py b/src/apideck/model/order_discounts.py new file mode 100644 index 0000000000..2089544bc2 --- /dev/null +++ b/src/apideck/model/order_discounts.py @@ -0,0 +1,295 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.currency import Currency + globals()['Currency'] = Currency + + +class OrderDiscounts(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('type',): { + 'PERCENTAGE': "percentage", + 'FLAT_FEE': "flat_fee", + }, + ('scope',): { + 'ORDER': "order", + 'LINE_ITEM': "line_item", + }, + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'id': (str,), # noqa: E501 + 'product_id': (str,), # noqa: E501 + 'name': (str,), # noqa: E501 + 'type': (str,), # noqa: E501 + 'amount': (int,), # noqa: E501 + 'currency': (Currency,), # noqa: E501 + 'scope': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'product_id': 'product_id', # noqa: E501 + 'name': 'name', # noqa: E501 + 'type': 'type', # noqa: E501 + 'amount': 'amount', # noqa: E501 + 'currency': 'currency', # noqa: E501 + 'scope': 'scope', # noqa: E501 + } + + read_only_vars = { + 'id', # noqa: E501 + 'product_id', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """OrderDiscounts - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + product_id (str): [optional] # noqa: E501 + name (str): [optional] # noqa: E501 + type (str): [optional] # noqa: E501 + amount (int): [optional] # noqa: E501 + currency (Currency): [optional] # noqa: E501 + scope (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """OrderDiscounts - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + product_id (str): [optional] # noqa: E501 + name (str): [optional] # noqa: E501 + type (str): [optional] # noqa: E501 + amount (int): [optional] # noqa: E501 + currency (Currency): [optional] # noqa: E501 + scope (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/order_fulfillments.py b/src/apideck/model/order_fulfillments.py new file mode 100644 index 0000000000..93f036c182 --- /dev/null +++ b/src/apideck/model/order_fulfillments.py @@ -0,0 +1,290 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.order_pickup_details import OrderPickupDetails + globals()['OrderPickupDetails'] = OrderPickupDetails + + +class OrderFulfillments(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('status',): { + 'PROPOSED': "proposed", + 'RESERVED': "reserved", + 'PREPARED': "prepared", + 'COMPLETED': "completed", + 'CANCELLED': "cancelled", + 'FAILED': "failed", + 'OTHER': "other", + }, + ('type',): { + 'PICKUP': "pickup", + 'SHIPMENT': "shipment", + }, + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'id': (str,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'type': (str,), # noqa: E501 + 'pickup_details': (OrderPickupDetails,), # noqa: E501 + 'shipment_details': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'status': 'status', # noqa: E501 + 'type': 'type', # noqa: E501 + 'pickup_details': 'pickup_details', # noqa: E501 + 'shipment_details': 'shipment_details', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """OrderFulfillments - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + status (str): The state of the fulfillment.. [optional] # noqa: E501 + type (str): [optional] # noqa: E501 + pickup_details (OrderPickupDetails): [optional] # noqa: E501 + shipment_details ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """OrderFulfillments - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + status (str): The state of the fulfillment.. [optional] # noqa: E501 + type (str): [optional] # noqa: E501 + pickup_details (OrderPickupDetails): [optional] # noqa: E501 + shipment_details ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/order_line_items.py b/src/apideck/model/order_line_items.py new file mode 100644 index 0000000000..281241a508 --- /dev/null +++ b/src/apideck/model/order_line_items.py @@ -0,0 +1,296 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class OrderLineItems(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'id': (str,), # noqa: E501 + 'name': (str,), # noqa: E501 + 'item': (bool, date, datetime, dict, float, int, list, str, none_type,), # noqa: E501 + 'total_tax': (int, none_type,), # noqa: E501 + 'total_discount': (int, none_type,), # noqa: E501 + 'total_amount': (int, none_type,), # noqa: E501 + 'quantity': (float, none_type,), # noqa: E501 + 'unit_price': (float, none_type,), # noqa: E501 + 'applied_taxes': ([bool, date, datetime, dict, float, int, list, str, none_type],), # noqa: E501 + 'applied_discounts': ([bool, date, datetime, dict, float, int, list, str, none_type],), # noqa: E501 + 'modifiers': ([bool, date, datetime, dict, float, int, list, str, none_type],), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'name': 'name', # noqa: E501 + 'item': 'item', # noqa: E501 + 'total_tax': 'total_tax', # noqa: E501 + 'total_discount': 'total_discount', # noqa: E501 + 'total_amount': 'total_amount', # noqa: E501 + 'quantity': 'quantity', # noqa: E501 + 'unit_price': 'unit_price', # noqa: E501 + 'applied_taxes': 'applied_taxes', # noqa: E501 + 'applied_discounts': 'applied_discounts', # noqa: E501 + 'modifiers': 'modifiers', # noqa: E501 + } + + read_only_vars = { + 'id', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """OrderLineItems - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + name (str): [optional] # noqa: E501 + item (bool, date, datetime, dict, float, int, list, str, none_type): [optional] # noqa: E501 + total_tax (int, none_type): [optional] # noqa: E501 + total_discount (int, none_type): [optional] # noqa: E501 + total_amount (int, none_type): [optional] # noqa: E501 + quantity (float, none_type): [optional] # noqa: E501 + unit_price (float, none_type): [optional] # noqa: E501 + applied_taxes ([bool, date, datetime, dict, float, int, list, str, none_type]): [optional] # noqa: E501 + applied_discounts ([bool, date, datetime, dict, float, int, list, str, none_type]): [optional] # noqa: E501 + modifiers ([bool, date, datetime, dict, float, int, list, str, none_type]): Customizable options – toppings, add-ons, or special requests – create item modifiers. Modifiers that are applied to items will display on your customers’ digital receipts. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """OrderLineItems - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + name (str): [optional] # noqa: E501 + item (bool, date, datetime, dict, float, int, list, str, none_type): [optional] # noqa: E501 + total_tax (int, none_type): [optional] # noqa: E501 + total_discount (int, none_type): [optional] # noqa: E501 + total_amount (int, none_type): [optional] # noqa: E501 + quantity (float, none_type): [optional] # noqa: E501 + unit_price (float, none_type): [optional] # noqa: E501 + applied_taxes ([bool, date, datetime, dict, float, int, list, str, none_type]): [optional] # noqa: E501 + applied_discounts ([bool, date, datetime, dict, float, int, list, str, none_type]): [optional] # noqa: E501 + modifiers ([bool, date, datetime, dict, float, int, list, str, none_type]): Customizable options – toppings, add-ons, or special requests – create item modifiers. Modifiers that are applied to items will display on your customers’ digital receipts. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/order_payments.py b/src/apideck/model/order_payments.py new file mode 100644 index 0000000000..2f1317bb7c --- /dev/null +++ b/src/apideck/model/order_payments.py @@ -0,0 +1,270 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.currency import Currency + globals()['Currency'] = Currency + + +class OrderPayments(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'id': (str,), # noqa: E501 + 'amount': (int,), # noqa: E501 + 'currency': (Currency,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'amount': 'amount', # noqa: E501 + 'currency': 'currency', # noqa: E501 + } + + read_only_vars = { + 'id', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """OrderPayments - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + amount (int): [optional] # noqa: E501 + currency (Currency): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """OrderPayments - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + amount (int): [optional] # noqa: E501 + currency (Currency): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/order_pickup_details.py b/src/apideck/model/order_pickup_details.py new file mode 100644 index 0000000000..018971a66d --- /dev/null +++ b/src/apideck/model/order_pickup_details.py @@ -0,0 +1,335 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.order_pickup_details_curbside_pickup_details import OrderPickupDetailsCurbsidePickupDetails + from apideck.model.order_pickup_details_recipient import OrderPickupDetailsRecipient + globals()['OrderPickupDetailsCurbsidePickupDetails'] = OrderPickupDetailsCurbsidePickupDetails + globals()['OrderPickupDetailsRecipient'] = OrderPickupDetailsRecipient + + +class OrderPickupDetails(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('schedule_type',): { + 'SCHEDULED': "scheduled", + }, + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'accepted_at': (datetime, none_type,), # noqa: E501 + 'auto_complete_duration': (str, none_type,), # noqa: E501 + 'cancel_reason': (str, none_type,), # noqa: E501 + 'expires_at': (datetime,), # noqa: E501 + 'schedule_type': (str,), # noqa: E501 + 'pickup_at': (datetime,), # noqa: E501 + 'pickup_window_duration': (str,), # noqa: E501 + 'prep_time_duration': (str,), # noqa: E501 + 'note': (str,), # noqa: E501 + 'placed_at': (datetime,), # noqa: E501 + 'rejected_at': (datetime,), # noqa: E501 + 'ready_at': (datetime,), # noqa: E501 + 'expired_at': (datetime,), # noqa: E501 + 'picked_up_at': (datetime,), # noqa: E501 + 'canceled_at': (datetime,), # noqa: E501 + 'is_curbside_pickup': (bool,), # noqa: E501 + 'curbside_pickup_details': (OrderPickupDetailsCurbsidePickupDetails,), # noqa: E501 + 'recipient': (OrderPickupDetailsRecipient,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'accepted_at': 'accepted_at', # noqa: E501 + 'auto_complete_duration': 'auto_complete_duration', # noqa: E501 + 'cancel_reason': 'cancel_reason', # noqa: E501 + 'expires_at': 'expires_at', # noqa: E501 + 'schedule_type': 'schedule_type', # noqa: E501 + 'pickup_at': 'pickup_at', # noqa: E501 + 'pickup_window_duration': 'pickup_window_duration', # noqa: E501 + 'prep_time_duration': 'prep_time_duration', # noqa: E501 + 'note': 'note', # noqa: E501 + 'placed_at': 'placed_at', # noqa: E501 + 'rejected_at': 'rejected_at', # noqa: E501 + 'ready_at': 'ready_at', # noqa: E501 + 'expired_at': 'expired_at', # noqa: E501 + 'picked_up_at': 'picked_up_at', # noqa: E501 + 'canceled_at': 'canceled_at', # noqa: E501 + 'is_curbside_pickup': 'is_curbside_pickup', # noqa: E501 + 'curbside_pickup_details': 'curbside_pickup_details', # noqa: E501 + 'recipient': 'recipient', # noqa: E501 + } + + read_only_vars = { + 'accepted_at', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """OrderPickupDetails - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + accepted_at (datetime, none_type): [optional] # noqa: E501 + auto_complete_duration (str, none_type): The duration of time after which an open and accepted pickup fulfillment is automatically moved to the COMPLETED state. The duration must be in RFC 3339 format (for example, 'P1W3D').. [optional] # noqa: E501 + cancel_reason (str, none_type): A description of why the pickup was canceled.. [optional] # noqa: E501 + expires_at (datetime): Indicating when this fulfillment expires if it is not accepted. The timestamp must be in RFC 3339 format (for example, \"2016-09-04T23:59:33.123Z\"). The expiration time can only be set up to 7 days in the future. If `expires_at` is not set, this pickup fulfillment is automatically accepted when placed.. [optional] # noqa: E501 + schedule_type (str): The schedule type of the pickup fulfillment.. [optional] if omitted the server will use the default value of "scheduled" # noqa: E501 + pickup_at (datetime): The timestamp that represents the start of the pickup window. Must be in RFC 3339 timestamp format, e.g., \"2016-09-04T23:59:33.123Z\". For fulfillments with the schedule type `ASAP`, this is automatically set to the current time plus the expected duration to prepare the fulfillment.. [optional] # noqa: E501 + pickup_window_duration (str): The window of time in which the order should be picked up after the `pickup_at` timestamp. Must be in RFC 3339 duration format, e.g., \"P1W3D\". Can be used as an informational guideline for merchants.. [optional] # noqa: E501 + prep_time_duration (str): The duration of time it takes to prepare this fulfillment. The duration must be in RFC 3339 format (for example, \"P1W3D\").. [optional] # noqa: E501 + note (str): A note meant to provide additional instructions about the pickup fulfillment displayed in the Square Point of Sale application and set by the API.. [optional] # noqa: E501 + placed_at (datetime): Indicating when the fulfillment was placed. The timestamp must be in RFC 3339 format (for example, \"2016-09-04T23:59:33.123Z\").. [optional] # noqa: E501 + rejected_at (datetime): Indicating when the fulfillment was rejected. The timestamp must be in RFC 3339 format (for example, \"2016-09-04T23:59:33.123Z\").. [optional] # noqa: E501 + ready_at (datetime): Indicating when the fulfillment is marked as ready for pickup. The timestamp must be in RFC 3339 format (for example, \"2016-09-04T23:59:33.123Z\").. [optional] # noqa: E501 + expired_at (datetime): Indicating when the fulfillment expired. The timestamp must be in RFC 3339 format (for example, \"2016-09-04T23:59:33.123Z\").. [optional] # noqa: E501 + picked_up_at (datetime): Indicating when the fulfillment was picked up by the recipient. The timestamp must be in RFC 3339 format (for example, \"2016-09-04T23:59:33.123Z\").. [optional] # noqa: E501 + canceled_at (datetime): Indicating when the fulfillment was canceled. The timestamp must be in RFC 3339 format (for example, \"2016-09-04T23:59:33.123Z\").. [optional] # noqa: E501 + is_curbside_pickup (bool): If set to `true`, indicates that this pickup order is for curbside pickup, not in-store pickup.. [optional] # noqa: E501 + curbside_pickup_details (OrderPickupDetailsCurbsidePickupDetails): [optional] # noqa: E501 + recipient (OrderPickupDetailsRecipient): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """OrderPickupDetails - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + accepted_at (datetime, none_type): [optional] # noqa: E501 + auto_complete_duration (str, none_type): The duration of time after which an open and accepted pickup fulfillment is automatically moved to the COMPLETED state. The duration must be in RFC 3339 format (for example, 'P1W3D').. [optional] # noqa: E501 + cancel_reason (str, none_type): A description of why the pickup was canceled.. [optional] # noqa: E501 + expires_at (datetime): Indicating when this fulfillment expires if it is not accepted. The timestamp must be in RFC 3339 format (for example, \"2016-09-04T23:59:33.123Z\"). The expiration time can only be set up to 7 days in the future. If `expires_at` is not set, this pickup fulfillment is automatically accepted when placed.. [optional] # noqa: E501 + schedule_type (str): The schedule type of the pickup fulfillment.. [optional] if omitted the server will use the default value of "scheduled" # noqa: E501 + pickup_at (datetime): The timestamp that represents the start of the pickup window. Must be in RFC 3339 timestamp format, e.g., \"2016-09-04T23:59:33.123Z\". For fulfillments with the schedule type `ASAP`, this is automatically set to the current time plus the expected duration to prepare the fulfillment.. [optional] # noqa: E501 + pickup_window_duration (str): The window of time in which the order should be picked up after the `pickup_at` timestamp. Must be in RFC 3339 duration format, e.g., \"P1W3D\". Can be used as an informational guideline for merchants.. [optional] # noqa: E501 + prep_time_duration (str): The duration of time it takes to prepare this fulfillment. The duration must be in RFC 3339 format (for example, \"P1W3D\").. [optional] # noqa: E501 + note (str): A note meant to provide additional instructions about the pickup fulfillment displayed in the Square Point of Sale application and set by the API.. [optional] # noqa: E501 + placed_at (datetime): Indicating when the fulfillment was placed. The timestamp must be in RFC 3339 format (for example, \"2016-09-04T23:59:33.123Z\").. [optional] # noqa: E501 + rejected_at (datetime): Indicating when the fulfillment was rejected. The timestamp must be in RFC 3339 format (for example, \"2016-09-04T23:59:33.123Z\").. [optional] # noqa: E501 + ready_at (datetime): Indicating when the fulfillment is marked as ready for pickup. The timestamp must be in RFC 3339 format (for example, \"2016-09-04T23:59:33.123Z\").. [optional] # noqa: E501 + expired_at (datetime): Indicating when the fulfillment expired. The timestamp must be in RFC 3339 format (for example, \"2016-09-04T23:59:33.123Z\").. [optional] # noqa: E501 + picked_up_at (datetime): Indicating when the fulfillment was picked up by the recipient. The timestamp must be in RFC 3339 format (for example, \"2016-09-04T23:59:33.123Z\").. [optional] # noqa: E501 + canceled_at (datetime): Indicating when the fulfillment was canceled. The timestamp must be in RFC 3339 format (for example, \"2016-09-04T23:59:33.123Z\").. [optional] # noqa: E501 + is_curbside_pickup (bool): If set to `true`, indicates that this pickup order is for curbside pickup, not in-store pickup.. [optional] # noqa: E501 + curbside_pickup_details (OrderPickupDetailsCurbsidePickupDetails): [optional] # noqa: E501 + recipient (OrderPickupDetailsRecipient): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/order_pickup_details_curbside_pickup_details.py b/src/apideck/model/order_pickup_details_curbside_pickup_details.py new file mode 100644 index 0000000000..c09024a2db --- /dev/null +++ b/src/apideck/model/order_pickup_details_curbside_pickup_details.py @@ -0,0 +1,262 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class OrderPickupDetailsCurbsidePickupDetails(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + ('curbside_details',): { + 'max_length': 250, + }, + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'curbside_details': (str,), # noqa: E501 + 'buyer_arrived_at': (datetime,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'curbside_details': 'curbside_details', # noqa: E501 + 'buyer_arrived_at': 'buyer_arrived_at', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """OrderPickupDetailsCurbsidePickupDetails - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + curbside_details (str): Specific details for curbside pickup, such as parking number and vehicle model.. [optional] # noqa: E501 + buyer_arrived_at (datetime): Indicating when the buyer arrived and is waiting for pickup. The timestamp must be in RFC 3339 format (for example, \"2016-09-04T23:59:33.123Z\").. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """OrderPickupDetailsCurbsidePickupDetails - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + curbside_details (str): Specific details for curbside pickup, such as parking number and vehicle model.. [optional] # noqa: E501 + buyer_arrived_at (datetime): Indicating when the buyer arrived and is waiting for pickup. The timestamp must be in RFC 3339 format (for example, \"2016-09-04T23:59:33.123Z\").. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/order_pickup_details_recipient.py b/src/apideck/model/order_pickup_details_recipient.py new file mode 100644 index 0000000000..fb9dd0e070 --- /dev/null +++ b/src/apideck/model/order_pickup_details_recipient.py @@ -0,0 +1,281 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.address import Address + from apideck.model.email import Email + from apideck.model.phone_number import PhoneNumber + globals()['Address'] = Address + globals()['Email'] = Email + globals()['PhoneNumber'] = PhoneNumber + + +class OrderPickupDetailsRecipient(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'customer_id': (str,), # noqa: E501 + 'display_name': (str,), # noqa: E501 + 'address': (Address,), # noqa: E501 + 'phone_number': (PhoneNumber,), # noqa: E501 + 'email': (Email,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'customer_id': 'customer_id', # noqa: E501 + 'display_name': 'display_name', # noqa: E501 + 'address': 'address', # noqa: E501 + 'phone_number': 'phone_number', # noqa: E501 + 'email': 'email', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """OrderPickupDetailsRecipient - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + customer_id (str): [optional] # noqa: E501 + display_name (str): [optional] # noqa: E501 + address (Address): [optional] # noqa: E501 + phone_number (PhoneNumber): [optional] # noqa: E501 + email (Email): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """OrderPickupDetailsRecipient - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + customer_id (str): [optional] # noqa: E501 + display_name (str): [optional] # noqa: E501 + address (Address): [optional] # noqa: E501 + phone_number (PhoneNumber): [optional] # noqa: E501 + email (Email): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/order_refunds.py b/src/apideck/model/order_refunds.py new file mode 100644 index 0000000000..ad81bdbb6c --- /dev/null +++ b/src/apideck/model/order_refunds.py @@ -0,0 +1,299 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.currency import Currency + globals()['Currency'] = Currency + + +class OrderRefunds(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('status',): { + 'PENDING': "pending", + 'APPROVED': "approved", + 'REJECTED': "rejected", + 'FAILED': "failed", + }, + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'id': (str,), # noqa: E501 + 'location_id': (str,), # noqa: E501 + 'amount': (int,), # noqa: E501 + 'currency': (Currency,), # noqa: E501 + 'reason': (str,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'tender_id': (str,), # noqa: E501 + 'transaction_id': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'location_id': 'location_id', # noqa: E501 + 'amount': 'amount', # noqa: E501 + 'currency': 'currency', # noqa: E501 + 'reason': 'reason', # noqa: E501 + 'status': 'status', # noqa: E501 + 'tender_id': 'tender_id', # noqa: E501 + 'transaction_id': 'transaction_id', # noqa: E501 + } + + read_only_vars = { + 'id', # noqa: E501 + 'location_id', # noqa: E501 + 'tender_id', # noqa: E501 + 'transaction_id', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """OrderRefunds - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + location_id (str): [optional] # noqa: E501 + amount (int): [optional] # noqa: E501 + currency (Currency): [optional] # noqa: E501 + reason (str): [optional] # noqa: E501 + status (str): [optional] # noqa: E501 + tender_id (str): [optional] # noqa: E501 + transaction_id (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """OrderRefunds - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + location_id (str): [optional] # noqa: E501 + amount (int): [optional] # noqa: E501 + currency (Currency): [optional] # noqa: E501 + reason (str): [optional] # noqa: E501 + status (str): [optional] # noqa: E501 + tender_id (str): [optional] # noqa: E501 + transaction_id (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/order_tenders.py b/src/apideck/model/order_tenders.py new file mode 100644 index 0000000000..70e24fa6cb --- /dev/null +++ b/src/apideck/model/order_tenders.py @@ -0,0 +1,371 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.currency import Currency + from apideck.model.payment_card import PaymentCard + globals()['Currency'] = Currency + globals()['PaymentCard'] = PaymentCard + + +class OrderTenders(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('type',): { + 'CASH': "cash", + 'CARD': "card", + 'OTHER': "other", + }, + ('card_status',): { + 'None': None, + 'AUTHORIZED': "authorized", + 'CAPTURED': "captured", + 'FAILED': "failed", + 'VOIDED': "voided", + }, + ('card_entry_method',): { + 'None': None, + 'EVM': "evm", + 'SWIPED': "swiped", + 'KEYED': "keyed", + 'ON-FILE': "on-file", + 'CONTACTLESS': "contactless", + }, + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'id': (str,), # noqa: E501 + 'name': (str,), # noqa: E501 + 'type': (str,), # noqa: E501 + 'note': (str,), # noqa: E501 + 'amount': (float,), # noqa: E501 + 'percentage': (float,), # noqa: E501 + 'currency': (Currency,), # noqa: E501 + 'total_amount': (int, none_type,), # noqa: E501 + 'total_tip': (int, none_type,), # noqa: E501 + 'total_processing_fee': (int, none_type,), # noqa: E501 + 'total_tax': (int, none_type,), # noqa: E501 + 'total_discount': (int, none_type,), # noqa: E501 + 'total_refund': (int, none_type,), # noqa: E501 + 'total_service_charge': (int, none_type,), # noqa: E501 + 'buyer_tendered_cash_amount': (int, none_type,), # noqa: E501 + 'change_back_cash_amount': (int, none_type,), # noqa: E501 + 'card': (PaymentCard,), # noqa: E501 + 'card_status': (str, none_type,), # noqa: E501 + 'card_entry_method': (str, none_type,), # noqa: E501 + 'payment_id': (str,), # noqa: E501 + 'location_id': (str,), # noqa: E501 + 'transaction_id': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'name': 'name', # noqa: E501 + 'type': 'type', # noqa: E501 + 'note': 'note', # noqa: E501 + 'amount': 'amount', # noqa: E501 + 'percentage': 'percentage', # noqa: E501 + 'currency': 'currency', # noqa: E501 + 'total_amount': 'total_amount', # noqa: E501 + 'total_tip': 'total_tip', # noqa: E501 + 'total_processing_fee': 'total_processing_fee', # noqa: E501 + 'total_tax': 'total_tax', # noqa: E501 + 'total_discount': 'total_discount', # noqa: E501 + 'total_refund': 'total_refund', # noqa: E501 + 'total_service_charge': 'total_service_charge', # noqa: E501 + 'buyer_tendered_cash_amount': 'buyer_tendered_cash_amount', # noqa: E501 + 'change_back_cash_amount': 'change_back_cash_amount', # noqa: E501 + 'card': 'card', # noqa: E501 + 'card_status': 'card_status', # noqa: E501 + 'card_entry_method': 'card_entry_method', # noqa: E501 + 'payment_id': 'payment_id', # noqa: E501 + 'location_id': 'location_id', # noqa: E501 + 'transaction_id': 'transaction_id', # noqa: E501 + } + + read_only_vars = { + 'id', # noqa: E501 + 'payment_id', # noqa: E501 + 'location_id', # noqa: E501 + 'transaction_id', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """OrderTenders - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + name (str): [optional] # noqa: E501 + type (str): [optional] # noqa: E501 + note (str): [optional] # noqa: E501 + amount (float): [optional] # noqa: E501 + percentage (float): [optional] # noqa: E501 + currency (Currency): [optional] # noqa: E501 + total_amount (int, none_type): [optional] # noqa: E501 + total_tip (int, none_type): [optional] # noqa: E501 + total_processing_fee (int, none_type): [optional] # noqa: E501 + total_tax (int, none_type): [optional] # noqa: E501 + total_discount (int, none_type): [optional] # noqa: E501 + total_refund (int, none_type): [optional] # noqa: E501 + total_service_charge (int, none_type): [optional] # noqa: E501 + buyer_tendered_cash_amount (int, none_type): The amount (in cents) of cash tendered by the buyer. Only applicable when the tender type is cash.. [optional] # noqa: E501 + change_back_cash_amount (int, none_type): The amount (in cents) of cash returned to the buyer. Only applicable when the tender type is cash.. [optional] # noqa: E501 + card (PaymentCard): [optional] # noqa: E501 + card_status (str, none_type): The status of the card. Only applicable when the tender type is card.. [optional] # noqa: E501 + card_entry_method (str, none_type): The entry method of the card. Only applicable when the tender type is card.. [optional] # noqa: E501 + payment_id (str): [optional] # noqa: E501 + location_id (str): [optional] # noqa: E501 + transaction_id (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """OrderTenders - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + name (str): [optional] # noqa: E501 + type (str): [optional] # noqa: E501 + note (str): [optional] # noqa: E501 + amount (float): [optional] # noqa: E501 + percentage (float): [optional] # noqa: E501 + currency (Currency): [optional] # noqa: E501 + total_amount (int, none_type): [optional] # noqa: E501 + total_tip (int, none_type): [optional] # noqa: E501 + total_processing_fee (int, none_type): [optional] # noqa: E501 + total_tax (int, none_type): [optional] # noqa: E501 + total_discount (int, none_type): [optional] # noqa: E501 + total_refund (int, none_type): [optional] # noqa: E501 + total_service_charge (int, none_type): [optional] # noqa: E501 + buyer_tendered_cash_amount (int, none_type): The amount (in cents) of cash tendered by the buyer. Only applicable when the tender type is cash.. [optional] # noqa: E501 + change_back_cash_amount (int, none_type): The amount (in cents) of cash returned to the buyer. Only applicable when the tender type is cash.. [optional] # noqa: E501 + card (PaymentCard): [optional] # noqa: E501 + card_status (str, none_type): The status of the card. Only applicable when the tender type is card.. [optional] # noqa: E501 + card_entry_method (str, none_type): The entry method of the card. Only applicable when the tender type is card.. [optional] # noqa: E501 + payment_id (str): [optional] # noqa: E501 + location_id (str): [optional] # noqa: E501 + transaction_id (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/order_type.py b/src/apideck/model/order_type.py new file mode 100644 index 0000000000..6998ebe723 --- /dev/null +++ b/src/apideck/model/order_type.py @@ -0,0 +1,278 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class OrderType(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'id': (str,), # noqa: E501 + 'name': (str,), # noqa: E501 + 'default': (bool,), # noqa: E501 + 'updated_by': (str, none_type,), # noqa: E501 + 'created_by': (str, none_type,), # noqa: E501 + 'updated_at': (datetime,), # noqa: E501 + 'created_at': (datetime,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'name': 'name', # noqa: E501 + 'default': 'default', # noqa: E501 + 'updated_by': 'updated_by', # noqa: E501 + 'created_by': 'created_by', # noqa: E501 + 'updated_at': 'updated_at', # noqa: E501 + 'created_at': 'created_at', # noqa: E501 + } + + read_only_vars = { + 'id', # noqa: E501 + 'updated_by', # noqa: E501 + 'created_by', # noqa: E501 + 'updated_at', # noqa: E501 + 'created_at', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """OrderType - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + name (str): [optional] # noqa: E501 + default (bool): [optional] # noqa: E501 + updated_by (str, none_type): [optional] # noqa: E501 + created_by (str, none_type): [optional] # noqa: E501 + updated_at (datetime): [optional] # noqa: E501 + created_at (datetime): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """OrderType - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + name (str): [optional] # noqa: E501 + default (bool): [optional] # noqa: E501 + updated_by (str, none_type): [optional] # noqa: E501 + created_by (str, none_type): [optional] # noqa: E501 + updated_at (datetime): [optional] # noqa: E501 + created_at (datetime): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/owner.py b/src/apideck/model/owner.py new file mode 100644 index 0000000000..c3603ed5c6 --- /dev/null +++ b/src/apideck/model/owner.py @@ -0,0 +1,266 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class Owner(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'id': (str,), # noqa: E501 + 'email': (str,), # noqa: E501 + 'name': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'email': 'email', # noqa: E501 + 'name': 'name', # noqa: E501 + } + + read_only_vars = { + 'id', # noqa: E501 + 'email', # noqa: E501 + 'name', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """Owner - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): ID of the owner. [optional] # noqa: E501 + email (str): Email of the owner. [optional] # noqa: E501 + name (str): Name of the owner. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """Owner - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): ID of the owner. [optional] # noqa: E501 + email (str): Email of the owner. [optional] # noqa: E501 + name (str): Name of the owner. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/pagination_coverage.py b/src/apideck/model/pagination_coverage.py new file mode 100644 index 0000000000..4152d39850 --- /dev/null +++ b/src/apideck/model/pagination_coverage.py @@ -0,0 +1,267 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class PaginationCoverage(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('mode',): { + 'NATIVE': "native", + 'VIRTUAL': "virtual", + }, + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'mode': (str,), # noqa: E501 + 'paging_support': (bool,), # noqa: E501 + 'limit_support': (bool,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'mode': 'mode', # noqa: E501 + 'paging_support': 'paging_support', # noqa: E501 + 'limit_support': 'limit_support', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """PaginationCoverage - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + mode (str): How pagination is implemented on this connector. Native mode means Apideck is using the pagination parameters of the connector. With virtual pagination, the connector does not support pagination, but Apideck emulates it.. [optional] # noqa: E501 + paging_support (bool): Indicates whether the connector supports paging through results using the cursor parameter.. [optional] # noqa: E501 + limit_support (bool): Indicates whether the connector supports changing the page size by using the limit parameter.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """PaginationCoverage - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + mode (str): How pagination is implemented on this connector. Native mode means Apideck is using the pagination parameters of the connector. With virtual pagination, the connector does not support pagination, but Apideck emulates it.. [optional] # noqa: E501 + paging_support (bool): Indicates whether the connector supports paging through results using the cursor parameter.. [optional] # noqa: E501 + limit_support (bool): Indicates whether the connector supports changing the page size by using the limit parameter.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/passthrough.py b/src/apideck/model/passthrough.py new file mode 100644 index 0000000000..ab0463870e --- /dev/null +++ b/src/apideck/model/passthrough.py @@ -0,0 +1,255 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class Passthrough(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'example_downstream_property': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'example_downstream_property': 'example_downstream_property', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """Passthrough - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + example_downstream_property (str): All passthrough query parameters are passed along to the connector as is (?pass_through[search]=leads becomes ?search=leads). [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """Passthrough - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + example_downstream_property (str): All passthrough query parameters are passed along to the connector as is (?pass_through[search]=leads becomes ?search=leads). [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/payment.py b/src/apideck/model/payment.py new file mode 100644 index 0000000000..6d40d8c7e9 --- /dev/null +++ b/src/apideck/model/payment.py @@ -0,0 +1,395 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.currency import Currency + from apideck.model.linked_customer import LinkedCustomer + from apideck.model.linked_ledger_account import LinkedLedgerAccount + from apideck.model.linked_supplier import LinkedSupplier + from apideck.model.payment_allocations import PaymentAllocations + globals()['Currency'] = Currency + globals()['LinkedCustomer'] = LinkedCustomer + globals()['LinkedLedgerAccount'] = LinkedLedgerAccount + globals()['LinkedSupplier'] = LinkedSupplier + globals()['PaymentAllocations'] = PaymentAllocations + + +class Payment(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('status',): { + 'AUTHORISED': "authorised", + 'PAID': "paid", + 'VOIDED': "voided", + 'DELETED': "deleted", + }, + ('type',): { + 'RECEIVABLE': "accounts_receivable", + 'PAYABLE': "accounts_payable", + 'RECEIVABLE_CREDIT': "accounts_receivable_credit", + 'PAYABLE_CREDIT': "accounts_payable_credit", + 'RECEIVABLE_OVERPAYMENT': "accounts_receivable_overpayment", + 'PAYABLE_OVERPAYMENT': "accounts_payable_overpayment", + 'RECEIVABLE_PREPAYMENT': "accounts_receivable_prepayment", + 'PAYABLE_PREPAYMENT': "accounts_payable_prepayment", + }, + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'total_amount': (float,), # noqa: E501 + 'transaction_date': (datetime,), # noqa: E501 + 'id': (str,), # noqa: E501 + 'downstream_id': (str, none_type,), # noqa: E501 + 'currency': (Currency,), # noqa: E501 + 'currency_rate': (float, none_type,), # noqa: E501 + 'reference': (str, none_type,), # noqa: E501 + 'payment_method': (str, none_type,), # noqa: E501 + 'payment_method_reference': (str, none_type,), # noqa: E501 + 'accounts_receivable_account_type': (str, none_type,), # noqa: E501 + 'accounts_receivable_account_id': (str, none_type,), # noqa: E501 + 'account': (LinkedLedgerAccount,), # noqa: E501 + 'customer': (LinkedCustomer,), # noqa: E501 + 'supplier': (LinkedSupplier,), # noqa: E501 + 'reconciled': (bool,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'type': (str,), # noqa: E501 + 'allocations': ([PaymentAllocations],), # noqa: E501 + 'note': (str, none_type,), # noqa: E501 + 'row_version': (str, none_type,), # noqa: E501 + 'display_id': (str, none_type,), # noqa: E501 + 'updated_by': (str, none_type,), # noqa: E501 + 'created_by': (str, none_type,), # noqa: E501 + 'created_at': (datetime,), # noqa: E501 + 'updated_at': (datetime,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'total_amount': 'total_amount', # noqa: E501 + 'transaction_date': 'transaction_date', # noqa: E501 + 'id': 'id', # noqa: E501 + 'downstream_id': 'downstream_id', # noqa: E501 + 'currency': 'currency', # noqa: E501 + 'currency_rate': 'currency_rate', # noqa: E501 + 'reference': 'reference', # noqa: E501 + 'payment_method': 'payment_method', # noqa: E501 + 'payment_method_reference': 'payment_method_reference', # noqa: E501 + 'accounts_receivable_account_type': 'accounts_receivable_account_type', # noqa: E501 + 'accounts_receivable_account_id': 'accounts_receivable_account_id', # noqa: E501 + 'account': 'account', # noqa: E501 + 'customer': 'customer', # noqa: E501 + 'supplier': 'supplier', # noqa: E501 + 'reconciled': 'reconciled', # noqa: E501 + 'status': 'status', # noqa: E501 + 'type': 'type', # noqa: E501 + 'allocations': 'allocations', # noqa: E501 + 'note': 'note', # noqa: E501 + 'row_version': 'row_version', # noqa: E501 + 'display_id': 'display_id', # noqa: E501 + 'updated_by': 'updated_by', # noqa: E501 + 'created_by': 'created_by', # noqa: E501 + 'created_at': 'created_at', # noqa: E501 + 'updated_at': 'updated_at', # noqa: E501 + } + + read_only_vars = { + 'id', # noqa: E501 + 'downstream_id', # noqa: E501 + 'updated_by', # noqa: E501 + 'created_by', # noqa: E501 + 'created_at', # noqa: E501 + 'updated_at', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, total_amount, transaction_date, *args, **kwargs): # noqa: E501 + """Payment - a model defined in OpenAPI + + Args: + total_amount (float): Amount of payment + transaction_date (datetime): Date transaction was entered - YYYY:MM::DDThh:mm:ss.sTZD + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): Unique identifier representing the entity. [optional] # noqa: E501 + downstream_id (str, none_type): The third-party API ID of original entity. [optional] # noqa: E501 + currency (Currency): [optional] # noqa: E501 + currency_rate (float, none_type): Currency Exchange Rate at the time entity was recorded/generated.. [optional] # noqa: E501 + reference (str, none_type): Optional payment reference message ie: Debit remittance detail.. [optional] # noqa: E501 + payment_method (str, none_type): Payment method. [optional] # noqa: E501 + payment_method_reference (str, none_type): Optional reference message returned by payment method on processing. [optional] # noqa: E501 + accounts_receivable_account_type (str, none_type): Type of accounts receivable account.. [optional] # noqa: E501 + accounts_receivable_account_id (str, none_type): Unique identifier for the account to allocate payment to.. [optional] # noqa: E501 + account (LinkedLedgerAccount): [optional] # noqa: E501 + customer (LinkedCustomer): [optional] # noqa: E501 + supplier (LinkedSupplier): [optional] # noqa: E501 + reconciled (bool): Payment has been reconciled. [optional] # noqa: E501 + status (str): Status of payment. [optional] # noqa: E501 + type (str): Type of payment. [optional] # noqa: E501 + allocations ([PaymentAllocations]): [optional] # noqa: E501 + note (str, none_type): Optional note to be associated with the payment.. [optional] # noqa: E501 + row_version (str, none_type): [optional] # noqa: E501 + display_id (str, none_type): Payment id to be displayed.. [optional] # noqa: E501 + updated_by (str, none_type): [optional] # noqa: E501 + created_by (str, none_type): [optional] # noqa: E501 + created_at (datetime): [optional] # noqa: E501 + updated_at (datetime): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.total_amount = total_amount + self.transaction_date = transaction_date + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, total_amount, transaction_date, *args, **kwargs): # noqa: E501 + """Payment - a model defined in OpenAPI + + Args: + total_amount (float): Amount of payment + transaction_date (datetime): Date transaction was entered - YYYY:MM::DDThh:mm:ss.sTZD + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): Unique identifier representing the entity. [optional] # noqa: E501 + downstream_id (str, none_type): The third-party API ID of original entity. [optional] # noqa: E501 + currency (Currency): [optional] # noqa: E501 + currency_rate (float, none_type): Currency Exchange Rate at the time entity was recorded/generated.. [optional] # noqa: E501 + reference (str, none_type): Optional payment reference message ie: Debit remittance detail.. [optional] # noqa: E501 + payment_method (str, none_type): Payment method. [optional] # noqa: E501 + payment_method_reference (str, none_type): Optional reference message returned by payment method on processing. [optional] # noqa: E501 + accounts_receivable_account_type (str, none_type): Type of accounts receivable account.. [optional] # noqa: E501 + accounts_receivable_account_id (str, none_type): Unique identifier for the account to allocate payment to.. [optional] # noqa: E501 + account (LinkedLedgerAccount): [optional] # noqa: E501 + customer (LinkedCustomer): [optional] # noqa: E501 + supplier (LinkedSupplier): [optional] # noqa: E501 + reconciled (bool): Payment has been reconciled. [optional] # noqa: E501 + status (str): Status of payment. [optional] # noqa: E501 + type (str): Type of payment. [optional] # noqa: E501 + allocations ([PaymentAllocations]): [optional] # noqa: E501 + note (str, none_type): Optional note to be associated with the payment.. [optional] # noqa: E501 + row_version (str, none_type): [optional] # noqa: E501 + display_id (str, none_type): Payment id to be displayed.. [optional] # noqa: E501 + updated_by (str, none_type): [optional] # noqa: E501 + created_by (str, none_type): [optional] # noqa: E501 + created_at (datetime): [optional] # noqa: E501 + updated_at (datetime): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.total_amount = total_amount + self.transaction_date = transaction_date + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/payment_allocations.py b/src/apideck/model/payment_allocations.py new file mode 100644 index 0000000000..2669f6a377 --- /dev/null +++ b/src/apideck/model/payment_allocations.py @@ -0,0 +1,276 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class PaymentAllocations(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('type',): { + 'INVOICE': "invoice", + 'ORDER': "order", + 'EXPENSE': "expense", + 'CREDIT_MEMO': "credit_memo", + 'OVER_PAYMENT': "over_payment", + 'PRE_PAYMENT': "pre_payment", + }, + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'id': (str,), # noqa: E501 + 'type': (str,), # noqa: E501 + 'code': (str,), # noqa: E501 + 'amount': (float, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'type': 'type', # noqa: E501 + 'code': 'code', # noqa: E501 + 'amount': 'amount', # noqa: E501 + } + + read_only_vars = { + 'code', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """PaymentAllocations - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): Unique identifier of entity this payment should be attributed to.. [optional] # noqa: E501 + type (str): Type of entity this payment should be attributed to.. [optional] # noqa: E501 + code (str): [optional] # noqa: E501 + amount (float, none_type): Amount of payment that should be attributed to this allocation. If null, the total_amount will be used.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """PaymentAllocations - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): Unique identifier of entity this payment should be attributed to.. [optional] # noqa: E501 + type (str): Type of entity this payment should be attributed to.. [optional] # noqa: E501 + code (str): [optional] # noqa: E501 + amount (float, none_type): Amount of payment that should be attributed to this allocation. If null, the total_amount will be used.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/payment_card.py b/src/apideck/model/payment_card.py new file mode 100644 index 0000000000..9a4a9524ac --- /dev/null +++ b/src/apideck/model/payment_card.py @@ -0,0 +1,349 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.address import Address + globals()['Address'] = Address + + +class PaymentCard(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('card_brand',): { + 'None': None, + 'VISA': "visa", + 'MASTERCARD': "mastercard", + 'AMEX': "amex", + 'DISCOVER': "discover", + 'DISCOVER-DINERS': "discover-diners", + 'JCB': "jcb", + 'CHINA-UNIONPAY': "china-unionpay", + 'SQUARE-GIFT-CARD': "square-gift-card", + 'SQUARE-CAPITAL-CARD': "square-capital-card", + 'INTERAC': "interac", + 'EFTPOS': "eftpos", + 'FELICA': "felica", + 'EBT': "ebt", + 'OTHER': "other", + }, + ('card_type',): { + 'None': None, + 'CREDIT': "credit", + 'DEBIT': "debit", + 'PREPAID': "prepaid", + 'OTHER': "other", + }, + ('prepaid_type',): { + 'None': None, + 'NON-PREPAID': "non-prepaid", + 'PREPAID': "prepaid", + 'UNKNOWN': "unknown", + }, + } + + validations = { + ('exp_month',): { + 'inclusive_maximum': 12, + 'inclusive_minimum': 1, + }, + } + + additional_properties_type = None + + _nullable = True + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'id': (str,), # noqa: E501 + 'bin': (str, none_type,), # noqa: E501 + 'card_brand': (str, none_type,), # noqa: E501 + 'card_type': (str, none_type,), # noqa: E501 + 'prepaid_type': (str, none_type,), # noqa: E501 + 'cardholder_name': (str, none_type,), # noqa: E501 + 'customer_id': (str, none_type,), # noqa: E501 + 'merchant_id': (str,), # noqa: E501 + 'exp_month': (int, none_type,), # noqa: E501 + 'exp_year': (int, none_type,), # noqa: E501 + 'fingerprint': (str, none_type,), # noqa: E501 + 'last_4': (str, none_type,), # noqa: E501 + 'enabled': (bool, none_type,), # noqa: E501 + 'billing_address': (Address,), # noqa: E501 + 'reference_id': (str, none_type,), # noqa: E501 + 'version': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'bin': 'bin', # noqa: E501 + 'card_brand': 'card_brand', # noqa: E501 + 'card_type': 'card_type', # noqa: E501 + 'prepaid_type': 'prepaid_type', # noqa: E501 + 'cardholder_name': 'cardholder_name', # noqa: E501 + 'customer_id': 'customer_id', # noqa: E501 + 'merchant_id': 'merchant_id', # noqa: E501 + 'exp_month': 'exp_month', # noqa: E501 + 'exp_year': 'exp_year', # noqa: E501 + 'fingerprint': 'fingerprint', # noqa: E501 + 'last_4': 'last_4', # noqa: E501 + 'enabled': 'enabled', # noqa: E501 + 'billing_address': 'billing_address', # noqa: E501 + 'reference_id': 'reference_id', # noqa: E501 + 'version': 'version', # noqa: E501 + } + + read_only_vars = { + 'id', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """PaymentCard - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + bin (str, none_type): The first six digits of the card number, known as the Bank Identification Number (BIN).. [optional] # noqa: E501 + card_brand (str, none_type): The first six digits of the card number, known as the Bank Identification Number (BIN).. [optional] # noqa: E501 + card_type (str, none_type): [optional] # noqa: E501 + prepaid_type (str, none_type): [optional] # noqa: E501 + cardholder_name (str, none_type): [optional] # noqa: E501 + customer_id (str, none_type): [optional] # noqa: E501 + merchant_id (str): [optional] # noqa: E501 + exp_month (int, none_type): The expiration month of the associated card as an integer between 1 and 12.. [optional] # noqa: E501 + exp_year (int, none_type): The four-digit year of the card's expiration date.. [optional] # noqa: E501 + fingerprint (str, none_type): [optional] # noqa: E501 + last_4 (str, none_type): [optional] # noqa: E501 + enabled (bool, none_type): Indicates whether or not a card can be used for payments.. [optional] # noqa: E501 + billing_address (Address): [optional] # noqa: E501 + reference_id (str, none_type): An optional user-defined reference ID that associates this record with another entity in an external system. For example, a customer ID from an external customer management system.. [optional] # noqa: E501 + version (str, none_type): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """PaymentCard - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + bin (str, none_type): The first six digits of the card number, known as the Bank Identification Number (BIN).. [optional] # noqa: E501 + card_brand (str, none_type): The first six digits of the card number, known as the Bank Identification Number (BIN).. [optional] # noqa: E501 + card_type (str, none_type): [optional] # noqa: E501 + prepaid_type (str, none_type): [optional] # noqa: E501 + cardholder_name (str, none_type): [optional] # noqa: E501 + customer_id (str, none_type): [optional] # noqa: E501 + merchant_id (str): [optional] # noqa: E501 + exp_month (int, none_type): The expiration month of the associated card as an integer between 1 and 12.. [optional] # noqa: E501 + exp_year (int, none_type): The four-digit year of the card's expiration date.. [optional] # noqa: E501 + fingerprint (str, none_type): [optional] # noqa: E501 + last_4 (str, none_type): [optional] # noqa: E501 + enabled (bool, none_type): Indicates whether or not a card can be used for payments.. [optional] # noqa: E501 + billing_address (Address): [optional] # noqa: E501 + reference_id (str, none_type): An optional user-defined reference ID that associates this record with another entity in an external system. For example, a customer ID from an external customer management system.. [optional] # noqa: E501 + version (str, none_type): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/payment_required_response.py b/src/apideck/model/payment_required_response.py new file mode 100644 index 0000000000..cc60ce3fc3 --- /dev/null +++ b/src/apideck/model/payment_required_response.py @@ -0,0 +1,275 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class PaymentRequiredResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'status_code': (float,), # noqa: E501 + 'error': (str,), # noqa: E501 + 'type_name': (str,), # noqa: E501 + 'message': (str,), # noqa: E501 + 'detail': (str,), # noqa: E501 + 'ref': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'error': 'error', # noqa: E501 + 'type_name': 'type_name', # noqa: E501 + 'message': 'message', # noqa: E501 + 'detail': 'detail', # noqa: E501 + 'ref': 'ref', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """PaymentRequiredResponse - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + status_code (float): HTTP status code. [optional] # noqa: E501 + error (str): Contains an explanation of the status_code as defined in HTTP/1.1 standard (RFC 7231). [optional] # noqa: E501 + type_name (str): The type of error returned. [optional] # noqa: E501 + message (str): A human-readable message providing more details about the error.. [optional] # noqa: E501 + detail (str): Contains parameter or domain specific information related to the error and why it occurred.. [optional] # noqa: E501 + ref (str): Link to documentation of error type. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """PaymentRequiredResponse - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + status_code (float): HTTP status code. [optional] # noqa: E501 + error (str): Contains an explanation of the status_code as defined in HTTP/1.1 standard (RFC 7231). [optional] # noqa: E501 + type_name (str): The type of error returned. [optional] # noqa: E501 + message (str): A human-readable message providing more details about the error.. [optional] # noqa: E501 + detail (str): Contains parameter or domain specific information related to the error and why it occurred.. [optional] # noqa: E501 + ref (str): Link to documentation of error type. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/payment_unit.py b/src/apideck/model/payment_unit.py new file mode 100644 index 0000000000..9c63ff8c88 --- /dev/null +++ b/src/apideck/model/payment_unit.py @@ -0,0 +1,285 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class PaymentUnit(ModelSimple): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('value',): { + 'HOUR': "hour", + 'WEEK': "week", + 'MONTH': "month", + 'YEAR': "year", + 'PAYCHECK': "paycheck", + }, + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'value': (str,), + } + + @cached_property + def discriminator(): + return None + + + attribute_map = {} + + read_only_vars = set() + + _composed_schemas = None + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): + """PaymentUnit - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] (str):, must be one of ["hour", "week", "month", "year", "paycheck", ] # noqa: E501 + + Keyword Args: + value (str):, must be one of ["hour", "week", "month", "year", "paycheck", ] # noqa: E501 + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + self.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): + """PaymentUnit - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] (str):, must be one of ["hour", "week", "month", "year", "paycheck", ] # noqa: E501 + + Keyword Args: + value (str):, must be one of ["hour", "week", "month", "year", "paycheck", ] # noqa: E501 + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + self.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + return self diff --git a/src/apideck/model/payroll.py b/src/apideck/model/payroll.py new file mode 100644 index 0000000000..b214fc1351 --- /dev/null +++ b/src/apideck/model/payroll.py @@ -0,0 +1,320 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.compensation import Compensation + from apideck.model.payroll_totals import PayrollTotals + globals()['Compensation'] = Compensation + globals()['PayrollTotals'] = PayrollTotals + + +class Payroll(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + ('check_date',): { + 'regex': { + 'pattern': r'^\d{4}-\d{2}-\d{2}$', # noqa: E501 + }, + }, + ('start_date',): { + 'regex': { + 'pattern': r'^\d{4}-\d{2}-\d{2}$', # noqa: E501 + }, + }, + ('end_date',): { + 'regex': { + 'pattern': r'^\d{4}-\d{2}-\d{2}$', # noqa: E501 + }, + }, + ('processed_date',): { + 'regex': { + 'pattern': r'^\d{4}-\d{2}-\d{2}$', # noqa: E501 + }, + }, + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'id': (str,), # noqa: E501 + 'processed': (bool,), # noqa: E501 + 'check_date': (str,), # noqa: E501 + 'start_date': (str,), # noqa: E501 + 'end_date': (str,), # noqa: E501 + 'company_id': (str, none_type,), # noqa: E501 + 'processed_date': (str, none_type,), # noqa: E501 + 'totals': (PayrollTotals,), # noqa: E501 + 'compensations': ([Compensation],), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'processed': 'processed', # noqa: E501 + 'check_date': 'check_date', # noqa: E501 + 'start_date': 'start_date', # noqa: E501 + 'end_date': 'end_date', # noqa: E501 + 'company_id': 'company_id', # noqa: E501 + 'processed_date': 'processed_date', # noqa: E501 + 'totals': 'totals', # noqa: E501 + 'compensations': 'compensations', # noqa: E501 + } + + read_only_vars = { + 'id', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, id, processed, check_date, start_date, end_date, *args, **kwargs): # noqa: E501 + """Payroll - a model defined in OpenAPI + + Args: + id (str): + processed (bool): Whether or not the payroll has been successfully processed. Note that processed payrolls cannot be updated. + check_date (str): The date on which employees will be paid for the payroll. + start_date (str): The start date, inclusive, of the pay period. + end_date (str): The end date, inclusive, of the pay period. + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + company_id (str, none_type): [optional] # noqa: E501 + processed_date (str, none_type): The date the payroll was processed.. [optional] # noqa: E501 + totals (PayrollTotals): [optional] # noqa: E501 + compensations ([Compensation]): An array of compensations for the payroll.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.id = id + self.processed = processed + self.check_date = check_date + self.start_date = start_date + self.end_date = end_date + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, processed, check_date, start_date, end_date, *args, **kwargs): # noqa: E501 + """Payroll - a model defined in OpenAPI + + processed (bool): Whether or not the payroll has been successfully processed. Note that processed payrolls cannot be updated. + check_date (str): The date on which employees will be paid for the payroll. + start_date (str): The start date, inclusive, of the pay period. + end_date (str): The end date, inclusive, of the pay period. + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + company_id (str, none_type): [optional] # noqa: E501 + processed_date (str, none_type): The date the payroll was processed.. [optional] # noqa: E501 + totals (PayrollTotals): [optional] # noqa: E501 + compensations ([Compensation]): An array of compensations for the payroll.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.processed = processed + self.check_date = check_date + self.start_date = start_date + self.end_date = end_date + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/payroll_totals.py b/src/apideck/model/payroll_totals.py new file mode 100644 index 0000000000..f69c194169 --- /dev/null +++ b/src/apideck/model/payroll_totals.py @@ -0,0 +1,287 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class PayrollTotals(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'company_debit': (float,), # noqa: E501 + 'tax_debit': (float,), # noqa: E501 + 'check_amount': (float,), # noqa: E501 + 'net_pay': (float,), # noqa: E501 + 'gross_pay': (float,), # noqa: E501 + 'employer_taxes': (float,), # noqa: E501 + 'employee_taxes': (float,), # noqa: E501 + 'employer_benefit_contributions': (float,), # noqa: E501 + 'employee_benefit_deductions': (float,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'company_debit': 'company_debit', # noqa: E501 + 'tax_debit': 'tax_debit', # noqa: E501 + 'check_amount': 'check_amount', # noqa: E501 + 'net_pay': 'net_pay', # noqa: E501 + 'gross_pay': 'gross_pay', # noqa: E501 + 'employer_taxes': 'employer_taxes', # noqa: E501 + 'employee_taxes': 'employee_taxes', # noqa: E501 + 'employer_benefit_contributions': 'employer_benefit_contributions', # noqa: E501 + 'employee_benefit_deductions': 'employee_benefit_deductions', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """PayrollTotals - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + company_debit (float): The total company debit for the payroll.. [optional] # noqa: E501 + tax_debit (float): The total tax debit for the payroll.. [optional] # noqa: E501 + check_amount (float): The total check amount for the payroll.. [optional] # noqa: E501 + net_pay (float): The net pay amount for the payroll.. [optional] # noqa: E501 + gross_pay (float): The gross pay amount for the payroll.. [optional] # noqa: E501 + employer_taxes (float): The total amount of employer paid taxes for the payroll.. [optional] # noqa: E501 + employee_taxes (float): The total amount of employee paid taxes for the payroll.. [optional] # noqa: E501 + employer_benefit_contributions (float): The total amount of company contributed benefits for the payroll.. [optional] # noqa: E501 + employee_benefit_deductions (float): The total amount of employee deducted benefits for the payroll.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """PayrollTotals - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + company_debit (float): The total company debit for the payroll.. [optional] # noqa: E501 + tax_debit (float): The total tax debit for the payroll.. [optional] # noqa: E501 + check_amount (float): The total check amount for the payroll.. [optional] # noqa: E501 + net_pay (float): The net pay amount for the payroll.. [optional] # noqa: E501 + gross_pay (float): The gross pay amount for the payroll.. [optional] # noqa: E501 + employer_taxes (float): The total amount of employer paid taxes for the payroll.. [optional] # noqa: E501 + employee_taxes (float): The total amount of employee paid taxes for the payroll.. [optional] # noqa: E501 + employer_benefit_contributions (float): The total amount of company contributed benefits for the payroll.. [optional] # noqa: E501 + employee_benefit_deductions (float): The total amount of employee deducted benefits for the payroll.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/payrolls_filter.py b/src/apideck/model/payrolls_filter.py new file mode 100644 index 0000000000..ffff0d8999 --- /dev/null +++ b/src/apideck/model/payrolls_filter.py @@ -0,0 +1,263 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class PayrollsFilter(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + ('start_date',): { + 'regex': { + 'pattern': r'^\d{4}-\d{2}-\d{2}$', # noqa: E501 + }, + }, + ('end_date',): { + 'regex': { + 'pattern': r'^\d{4}-\d{2}-\d{2}$', # noqa: E501 + }, + }, + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'start_date': (str,), # noqa: E501 + 'end_date': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'start_date': 'start_date', # noqa: E501 + 'end_date': 'end_date', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """PayrollsFilter - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + start_date (str): Return payrolls whose pay period is after the start date. [optional] # noqa: E501 + end_date (str): Return payrolls whose pay period is before the end date. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """PayrollsFilter - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + start_date (str): Return payrolls whose pay period is after the start date. [optional] # noqa: E501 + end_date (str): Return payrolls whose pay period is before the end date. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/phone_number.py b/src/apideck/model/phone_number.py new file mode 100644 index 0000000000..ad9ceb225d --- /dev/null +++ b/src/apideck/model/phone_number.py @@ -0,0 +1,291 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class PhoneNumber(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('type',): { + 'PRIMARY': "primary", + 'SECONDARY': "secondary", + 'HOME': "home", + 'WORK': "work", + 'OFFICE': "office", + 'MOBILE': "mobile", + 'ASSISTANT': "assistant", + 'FAX': "fax", + 'DIRECT-DIAL-IN': "direct-dial-in", + 'PERSONAL': "personal", + 'OTHER': "other", + }, + } + + validations = { + ('number',): { + 'min_length': 1, + }, + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'number': (str,), # noqa: E501 + 'id': (str, none_type,), # noqa: E501 + 'country_code': (str, none_type,), # noqa: E501 + 'area_code': (str, none_type,), # noqa: E501 + 'extension': (str, none_type,), # noqa: E501 + 'type': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'number': 'number', # noqa: E501 + 'id': 'id', # noqa: E501 + 'country_code': 'country_code', # noqa: E501 + 'area_code': 'area_code', # noqa: E501 + 'extension': 'extension', # noqa: E501 + 'type': 'type', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, number, *args, **kwargs): # noqa: E501 + """PhoneNumber - a model defined in OpenAPI + + Args: + number (str): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str, none_type): [optional] # noqa: E501 + country_code (str, none_type): [optional] # noqa: E501 + area_code (str, none_type): [optional] # noqa: E501 + extension (str, none_type): [optional] # noqa: E501 + type (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.number = number + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, number, *args, **kwargs): # noqa: E501 + """PhoneNumber - a model defined in OpenAPI + + Args: + number (str): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str, none_type): [optional] # noqa: E501 + country_code (str, none_type): [optional] # noqa: E501 + area_code (str, none_type): [optional] # noqa: E501 + extension (str, none_type): [optional] # noqa: E501 + type (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.number = number + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/pipeline.py b/src/apideck/model/pipeline.py new file mode 100644 index 0000000000..3f3c357a5e --- /dev/null +++ b/src/apideck/model/pipeline.py @@ -0,0 +1,303 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.currency import Currency + from apideck.model.pipeline_stages import PipelineStages + globals()['Currency'] = Currency + globals()['PipelineStages'] = PipelineStages + + +class Pipeline(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + ('name',): { + 'min_length': 1, + }, + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'name': (str,), # noqa: E501 + 'id': (str,), # noqa: E501 + 'currency': (Currency,), # noqa: E501 + 'archived': (bool,), # noqa: E501 + 'active': (bool,), # noqa: E501 + 'display_order': (int,), # noqa: E501 + 'win_probability_enabled': (bool,), # noqa: E501 + 'stages': ([PipelineStages],), # noqa: E501 + 'updated_at': (datetime,), # noqa: E501 + 'created_at': (datetime,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'name': 'name', # noqa: E501 + 'id': 'id', # noqa: E501 + 'currency': 'currency', # noqa: E501 + 'archived': 'archived', # noqa: E501 + 'active': 'active', # noqa: E501 + 'display_order': 'display_order', # noqa: E501 + 'win_probability_enabled': 'win_probability_enabled', # noqa: E501 + 'stages': 'stages', # noqa: E501 + 'updated_at': 'updated_at', # noqa: E501 + 'created_at': 'created_at', # noqa: E501 + } + + read_only_vars = { + 'updated_at', # noqa: E501 + 'created_at', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, name, *args, **kwargs): # noqa: E501 + """Pipeline - a model defined in OpenAPI + + Args: + name (str): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + currency (Currency): [optional] # noqa: E501 + archived (bool): [optional] # noqa: E501 + active (bool): [optional] # noqa: E501 + display_order (int): [optional] # noqa: E501 + win_probability_enabled (bool): [optional] # noqa: E501 + stages ([PipelineStages]): [optional] # noqa: E501 + updated_at (datetime): [optional] # noqa: E501 + created_at (datetime): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.name = name + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, name, *args, **kwargs): # noqa: E501 + """Pipeline - a model defined in OpenAPI + + Args: + name (str): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + currency (Currency): [optional] # noqa: E501 + archived (bool): [optional] # noqa: E501 + active (bool): [optional] # noqa: E501 + display_order (int): [optional] # noqa: E501 + win_probability_enabled (bool): [optional] # noqa: E501 + stages ([PipelineStages]): [optional] # noqa: E501 + updated_at (datetime): [optional] # noqa: E501 + created_at (datetime): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.name = name + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/pipeline_stages.py b/src/apideck/model/pipeline_stages.py new file mode 100644 index 0000000000..e9bbbf059c --- /dev/null +++ b/src/apideck/model/pipeline_stages.py @@ -0,0 +1,272 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class PipelineStages(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'id': (str,), # noqa: E501 + 'name': (str,), # noqa: E501 + 'value': (str,), # noqa: E501 + 'win_probability': (int,), # noqa: E501 + 'display_order': (int,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'name': 'name', # noqa: E501 + 'value': 'value', # noqa: E501 + 'win_probability': 'win_probability', # noqa: E501 + 'display_order': 'display_order', # noqa: E501 + } + + read_only_vars = { + 'id', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """PipelineStages - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + name (str): [optional] # noqa: E501 + value (str): [optional] # noqa: E501 + win_probability (int): The expected probability of winning an Opportunity in this Pipeline Stage. Valid values are [0-100].. [optional] # noqa: E501 + display_order (int): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """PipelineStages - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + name (str): [optional] # noqa: E501 + value (str): [optional] # noqa: E501 + win_probability (int): The expected probability of winning an Opportunity in this Pipeline Stage. Valid values are [0-100].. [optional] # noqa: E501 + display_order (int): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/pos_bank_account.py b/src/apideck/model/pos_bank_account.py new file mode 100644 index 0000000000..e1ac75f630 --- /dev/null +++ b/src/apideck/model/pos_bank_account.py @@ -0,0 +1,304 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.pos_bank_account_ach_details import PosBankAccountAchDetails + globals()['PosBankAccountAchDetails'] = PosBankAccountAchDetails + + +class PosBankAccount(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + ('bank_name',): { + 'max_length': 100, + }, + ('transfer_type',): { + 'max_length': 50, + }, + ('account_ownership_type',): { + 'max_length': 50, + }, + ('fingerprint',): { + 'max_length': 255, + }, + ('country',): { + 'max_length': 2, + 'min_length': 2, + }, + ('statement_description',): { + 'max_length': 1000, + }, + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'bank_name': (str,), # noqa: E501 + 'transfer_type': (str,), # noqa: E501 + 'account_ownership_type': (str,), # noqa: E501 + 'fingerprint': (str,), # noqa: E501 + 'country': (str, none_type,), # noqa: E501 + 'statement_description': (str,), # noqa: E501 + 'ach_details': (PosBankAccountAchDetails,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'bank_name': 'bank_name', # noqa: E501 + 'transfer_type': 'transfer_type', # noqa: E501 + 'account_ownership_type': 'account_ownership_type', # noqa: E501 + 'fingerprint': 'fingerprint', # noqa: E501 + 'country': 'country', # noqa: E501 + 'statement_description': 'statement_description', # noqa: E501 + 'ach_details': 'ach_details', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """PosBankAccount - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + bank_name (str): The name of the bank associated with the bank account.. [optional] # noqa: E501 + transfer_type (str): The type of the bank transfer. The type can be `ACH` or `UNKNOWN`.. [optional] # noqa: E501 + account_ownership_type (str): The ownership type of the bank account performing the transfer. The type can be `INDIVIDUAL`, `COMPANY`, or `UNKNOWN`.. [optional] # noqa: E501 + fingerprint (str): Uniquely identifies the bank account for this seller and can be used to determine if payments are from the same bank account.. [optional] # noqa: E501 + country (str, none_type): country code according to ISO 3166-1 alpha-2.. [optional] # noqa: E501 + statement_description (str): The statement description as sent to the bank.. [optional] # noqa: E501 + ach_details (PosBankAccountAchDetails): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """PosBankAccount - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + bank_name (str): The name of the bank associated with the bank account.. [optional] # noqa: E501 + transfer_type (str): The type of the bank transfer. The type can be `ACH` or `UNKNOWN`.. [optional] # noqa: E501 + account_ownership_type (str): The ownership type of the bank account performing the transfer. The type can be `INDIVIDUAL`, `COMPANY`, or `UNKNOWN`.. [optional] # noqa: E501 + fingerprint (str): Uniquely identifies the bank account for this seller and can be used to determine if payments are from the same bank account.. [optional] # noqa: E501 + country (str, none_type): country code according to ISO 3166-1 alpha-2.. [optional] # noqa: E501 + statement_description (str): The statement description as sent to the bank.. [optional] # noqa: E501 + ach_details (PosBankAccountAchDetails): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/pos_bank_account_ach_details.py b/src/apideck/model/pos_bank_account_ach_details.py new file mode 100644 index 0000000000..a730ef9d5e --- /dev/null +++ b/src/apideck/model/pos_bank_account_ach_details.py @@ -0,0 +1,272 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class PosBankAccountAchDetails(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + ('routing_number',): { + 'max_length': 50, + }, + ('account_number_suffix',): { + 'max_length': 4, + }, + ('account_type',): { + 'max_length': 50, + }, + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'routing_number': (str,), # noqa: E501 + 'account_number_suffix': (str,), # noqa: E501 + 'account_type': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'routing_number': 'routing_number', # noqa: E501 + 'account_number_suffix': 'account_number_suffix', # noqa: E501 + 'account_type': 'account_type', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """PosBankAccountAchDetails - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + routing_number (str): The routing number for the bank account.. [optional] # noqa: E501 + account_number_suffix (str): The last few digits of the bank account number.. [optional] # noqa: E501 + account_type (str): The type of the bank account performing the transfer. The account type can be `CHECKING`, `SAVINGS`, or `UNKNOWN`.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """PosBankAccountAchDetails - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + routing_number (str): The routing number for the bank account.. [optional] # noqa: E501 + account_number_suffix (str): The last few digits of the bank account number.. [optional] # noqa: E501 + account_type (str): The type of the bank account performing the transfer. The account type can be `CHECKING`, `SAVINGS`, or `UNKNOWN`.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/pos_payment.py b/src/apideck/model/pos_payment.py new file mode 100644 index 0000000000..f7d7779177 --- /dev/null +++ b/src/apideck/model/pos_payment.py @@ -0,0 +1,434 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.cash_details import CashDetails + from apideck.model.currency import Currency + from apideck.model.idempotency_key import IdempotencyKey + from apideck.model.pos_bank_account import PosBankAccount + from apideck.model.pos_payment_card_details import PosPaymentCardDetails + from apideck.model.pos_payment_external_details import PosPaymentExternalDetails + from apideck.model.service_charges import ServiceCharges + from apideck.model.wallet_details import WalletDetails + globals()['CashDetails'] = CashDetails + globals()['Currency'] = Currency + globals()['IdempotencyKey'] = IdempotencyKey + globals()['PosBankAccount'] = PosBankAccount + globals()['PosPaymentCardDetails'] = PosPaymentCardDetails + globals()['PosPaymentExternalDetails'] = PosPaymentExternalDetails + globals()['ServiceCharges'] = ServiceCharges + globals()['WalletDetails'] = WalletDetails + + +class PosPayment(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('source',): { + 'CARD': "card", + 'BANK_ACCOUNT': "bank_account", + 'WALLET': "wallet", + 'BNPL': "bnpl", + 'CASH': "cash", + 'EXTERNAL': "external", + 'OTHER': "other", + }, + ('status',): { + 'APPROVED': "approved", + 'PENDING': "pending", + 'COMPLETED': "completed", + 'CANCELED': "canceled", + 'FAILED': "failed", + 'OTHER': "other", + }, + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'source_id': (str,), # noqa: E501 + 'order_id': (str,), # noqa: E501 + 'customer_id': (str,), # noqa: E501 + 'tender_id': (str,), # noqa: E501 + 'amount': (float,), # noqa: E501 + 'currency': (Currency,), # noqa: E501 + 'id': (str,), # noqa: E501 + 'merchant_id': (str,), # noqa: E501 + 'employee_id': (str,), # noqa: E501 + 'location_id': (str,), # noqa: E501 + 'device_id': (str,), # noqa: E501 + 'external_payment_id': (str,), # noqa: E501 + 'idempotency_key': (IdempotencyKey,), # noqa: E501 + 'tip': (float,), # noqa: E501 + 'tax': (float,), # noqa: E501 + 'total': (float,), # noqa: E501 + 'app_fee': (float,), # noqa: E501 + 'change_back_cash_amount': (float,), # noqa: E501 + 'approved': (float,), # noqa: E501 + 'refunded': (float,), # noqa: E501 + 'processing_fees': ([bool, date, datetime, dict, float, int, list, str, none_type],), # noqa: E501 + 'source': (str,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'cash': (CashDetails,), # noqa: E501 + 'card_details': (PosPaymentCardDetails,), # noqa: E501 + 'bank_account': (PosBankAccount,), # noqa: E501 + 'wallet': (WalletDetails,), # noqa: E501 + 'external_details': (PosPaymentExternalDetails,), # noqa: E501 + 'service_charges': (ServiceCharges,), # noqa: E501 + 'updated_by': (str, none_type,), # noqa: E501 + 'created_by': (str, none_type,), # noqa: E501 + 'updated_at': (datetime,), # noqa: E501 + 'created_at': (datetime,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'source_id': 'source_id', # noqa: E501 + 'order_id': 'order_id', # noqa: E501 + 'customer_id': 'customer_id', # noqa: E501 + 'tender_id': 'tender_id', # noqa: E501 + 'amount': 'amount', # noqa: E501 + 'currency': 'currency', # noqa: E501 + 'id': 'id', # noqa: E501 + 'merchant_id': 'merchant_id', # noqa: E501 + 'employee_id': 'employee_id', # noqa: E501 + 'location_id': 'location_id', # noqa: E501 + 'device_id': 'device_id', # noqa: E501 + 'external_payment_id': 'external_payment_id', # noqa: E501 + 'idempotency_key': 'idempotency_key', # noqa: E501 + 'tip': 'tip', # noqa: E501 + 'tax': 'tax', # noqa: E501 + 'total': 'total', # noqa: E501 + 'app_fee': 'app_fee', # noqa: E501 + 'change_back_cash_amount': 'change_back_cash_amount', # noqa: E501 + 'approved': 'approved', # noqa: E501 + 'refunded': 'refunded', # noqa: E501 + 'processing_fees': 'processing_fees', # noqa: E501 + 'source': 'source', # noqa: E501 + 'status': 'status', # noqa: E501 + 'cash': 'cash', # noqa: E501 + 'card_details': 'card_details', # noqa: E501 + 'bank_account': 'bank_account', # noqa: E501 + 'wallet': 'wallet', # noqa: E501 + 'external_details': 'external_details', # noqa: E501 + 'service_charges': 'service_charges', # noqa: E501 + 'updated_by': 'updated_by', # noqa: E501 + 'created_by': 'created_by', # noqa: E501 + 'updated_at': 'updated_at', # noqa: E501 + 'created_at': 'created_at', # noqa: E501 + } + + read_only_vars = { + 'id', # noqa: E501 + 'updated_by', # noqa: E501 + 'created_by', # noqa: E501 + 'updated_at', # noqa: E501 + 'created_at', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, source_id, order_id, customer_id, tender_id, amount, currency, *args, **kwargs): # noqa: E501 + """PosPayment - a model defined in OpenAPI + + Args: + source_id (str): The ID for the source of funds for this payment. Square-only: This can be a payment token (card nonce) generated by the payment form or a card on file made linked to the customer. if recording a payment that the seller received outside of Square, specify either `CASH` or `EXTERNAL`. + order_id (str): + customer_id (str): + tender_id (str): + amount (float): + currency (Currency): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + merchant_id (str): [optional] # noqa: E501 + employee_id (str): [optional] # noqa: E501 + location_id (str): [optional] # noqa: E501 + device_id (str): [optional] # noqa: E501 + external_payment_id (str): [optional] # noqa: E501 + idempotency_key (IdempotencyKey): [optional] # noqa: E501 + tip (float): [optional] # noqa: E501 + tax (float): [optional] # noqa: E501 + total (float): [optional] # noqa: E501 + app_fee (float): The amount the developer is taking as a fee for facilitating the payment on behalf of the seller.. [optional] # noqa: E501 + change_back_cash_amount (float): [optional] # noqa: E501 + approved (float): The initial amount of money approved for this payment.. [optional] # noqa: E501 + refunded (float): The initial amount of money approved for this payment.. [optional] # noqa: E501 + processing_fees ([bool, date, datetime, dict, float, int, list, str, none_type]): [optional] # noqa: E501 + source (str): Source of this payment.. [optional] # noqa: E501 + status (str): Status of this payment.. [optional] # noqa: E501 + cash (CashDetails): [optional] # noqa: E501 + card_details (PosPaymentCardDetails): [optional] # noqa: E501 + bank_account (PosBankAccount): [optional] # noqa: E501 + wallet (WalletDetails): [optional] # noqa: E501 + external_details (PosPaymentExternalDetails): [optional] # noqa: E501 + service_charges (ServiceCharges): [optional] # noqa: E501 + updated_by (str, none_type): [optional] # noqa: E501 + created_by (str, none_type): [optional] # noqa: E501 + updated_at (datetime): [optional] # noqa: E501 + created_at (datetime): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.source_id = source_id + self.order_id = order_id + self.customer_id = customer_id + self.tender_id = tender_id + self.amount = amount + self.currency = currency + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, source_id, order_id, customer_id, tender_id, amount, currency, *args, **kwargs): # noqa: E501 + """PosPayment - a model defined in OpenAPI + + Args: + source_id (str): The ID for the source of funds for this payment. Square-only: This can be a payment token (card nonce) generated by the payment form or a card on file made linked to the customer. if recording a payment that the seller received outside of Square, specify either `CASH` or `EXTERNAL`. + order_id (str): + customer_id (str): + tender_id (str): + amount (float): + currency (Currency): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + merchant_id (str): [optional] # noqa: E501 + employee_id (str): [optional] # noqa: E501 + location_id (str): [optional] # noqa: E501 + device_id (str): [optional] # noqa: E501 + external_payment_id (str): [optional] # noqa: E501 + idempotency_key (IdempotencyKey): [optional] # noqa: E501 + tip (float): [optional] # noqa: E501 + tax (float): [optional] # noqa: E501 + total (float): [optional] # noqa: E501 + app_fee (float): The amount the developer is taking as a fee for facilitating the payment on behalf of the seller.. [optional] # noqa: E501 + change_back_cash_amount (float): [optional] # noqa: E501 + approved (float): The initial amount of money approved for this payment.. [optional] # noqa: E501 + refunded (float): The initial amount of money approved for this payment.. [optional] # noqa: E501 + processing_fees ([bool, date, datetime, dict, float, int, list, str, none_type]): [optional] # noqa: E501 + source (str): Source of this payment.. [optional] # noqa: E501 + status (str): Status of this payment.. [optional] # noqa: E501 + cash (CashDetails): [optional] # noqa: E501 + card_details (PosPaymentCardDetails): [optional] # noqa: E501 + bank_account (PosBankAccount): [optional] # noqa: E501 + wallet (WalletDetails): [optional] # noqa: E501 + external_details (PosPaymentExternalDetails): [optional] # noqa: E501 + service_charges (ServiceCharges): [optional] # noqa: E501 + updated_by (str, none_type): [optional] # noqa: E501 + created_by (str, none_type): [optional] # noqa: E501 + updated_at (datetime): [optional] # noqa: E501 + created_at (datetime): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.source_id = source_id + self.order_id = order_id + self.customer_id = customer_id + self.tender_id = tender_id + self.amount = amount + self.currency = currency + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/pos_payment_card_details.py b/src/apideck/model/pos_payment_card_details.py new file mode 100644 index 0000000000..cd3f50fd7c --- /dev/null +++ b/src/apideck/model/pos_payment_card_details.py @@ -0,0 +1,261 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.payment_card import PaymentCard + globals()['PaymentCard'] = PaymentCard + + +class PosPaymentCardDetails(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'card': (PaymentCard,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'card': 'card', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """PosPaymentCardDetails - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + card (PaymentCard): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """PosPaymentCardDetails - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + card (PaymentCard): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/pos_payment_external_details.py b/src/apideck/model/pos_payment_external_details.py new file mode 100644 index 0000000000..71f416f8cb --- /dev/null +++ b/src/apideck/model/pos_payment_external_details.py @@ -0,0 +1,298 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class PosPaymentExternalDetails(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('type',): { + 'CHECK': "check", + 'BANK_TRANSFER': "bank_transfer", + 'OTHER_GIFT_CARD': "other_gift_card", + 'CRYPTO': "crypto", + 'SQUARE_CASH': "square_cash", + 'SOCIAL': "social", + 'EXTERNAL': "external", + 'EMONEY': "emoney", + 'CARD': "card", + 'STORED_BALANCE': "stored_balance", + 'FOOD_VOUCHER': "food_voucher", + 'OTHER': "other", + }, + } + + validations = { + ('type',): { + 'max_length': 50, + }, + ('source',): { + 'max_length': 255, + }, + ('source_id',): { + 'max_length': 255, + }, + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'type': (str,), # noqa: E501 + 'source': (str,), # noqa: E501 + 'source_id': (str,), # noqa: E501 + 'source_fee_amount': (float,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'type': 'type', # noqa: E501 + 'source': 'source', # noqa: E501 + 'source_id': 'source_id', # noqa: E501 + 'source_fee_amount': 'source_fee_amount', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, type, source, *args, **kwargs): # noqa: E501 + """PosPaymentExternalDetails - a model defined in OpenAPI + + Args: + type (str): The type of external payment the seller received. It can be one of the following: - CHECK - Paid using a physical check. - BANK_TRANSFER - Paid using external bank transfer. - OTHER\\_GIFT\\_CARD - Paid using a non-Square gift card. - CRYPTO - Paid using a crypto currency. - SQUARE_CASH - Paid using Square Cash App. - SOCIAL - Paid using peer-to-peer payment applications. - EXTERNAL - A third-party application gathered this payment outside of Square. - EMONEY - Paid using an E-money provider. - CARD - A credit or debit card that Square does not support. - STORED_BALANCE - Use for house accounts, store credit, and so forth. - FOOD_VOUCHER - Restaurant voucher provided by employers to employees to pay for meals - OTHER - A type not listed here. + source (str): A description of the external payment source. For example, \"Food Delivery Service\". + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + source_id (str): An ID to associate the payment to its originating source.. [optional] # noqa: E501 + source_fee_amount (float): The fees paid to the source. The amount minus this field is the net amount seller receives.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.type = type + self.source = source + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, type, source, *args, **kwargs): # noqa: E501 + """PosPaymentExternalDetails - a model defined in OpenAPI + + Args: + type (str): The type of external payment the seller received. It can be one of the following: - CHECK - Paid using a physical check. - BANK_TRANSFER - Paid using external bank transfer. - OTHER\\_GIFT\\_CARD - Paid using a non-Square gift card. - CRYPTO - Paid using a crypto currency. - SQUARE_CASH - Paid using Square Cash App. - SOCIAL - Paid using peer-to-peer payment applications. - EXTERNAL - A third-party application gathered this payment outside of Square. - EMONEY - Paid using an E-money provider. - CARD - A credit or debit card that Square does not support. - STORED_BALANCE - Use for house accounts, store credit, and so forth. - FOOD_VOUCHER - Restaurant voucher provided by employers to employees to pay for meals - OTHER - A type not listed here. + source (str): A description of the external payment source. For example, \"Food Delivery Service\". + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + source_id (str): An ID to associate the payment to its originating source.. [optional] # noqa: E501 + source_fee_amount (float): The fees paid to the source. The amount minus this field is the net amount seller receives.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.type = type + self.source = source + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/price.py b/src/apideck/model/price.py new file mode 100644 index 0000000000..8c1161d9b0 --- /dev/null +++ b/src/apideck/model/price.py @@ -0,0 +1,271 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.currency import Currency + globals()['Currency'] = Currency + + +class Price(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'per_unit': (str,), # noqa: E501 + 'total_amount': (str,), # noqa: E501 + 'currency': (Currency,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'per_unit': 'per_unit', # noqa: E501 + 'total_amount': 'total_amount', # noqa: E501 + 'currency': 'currency', # noqa: E501 + } + + read_only_vars = { + 'per_unit', # noqa: E501 + 'total_amount', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """Price - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + per_unit (str): [optional] # noqa: E501 + total_amount (str): [optional] # noqa: E501 + currency (Currency): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """Price - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + per_unit (str): [optional] # noqa: E501 + total_amount (str): [optional] # noqa: E501 + currency (Currency): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/profit_and_loss.py b/src/apideck/model/profit_and_loss.py new file mode 100644 index 0000000000..95028286a7 --- /dev/null +++ b/src/apideck/model/profit_and_loss.py @@ -0,0 +1,325 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.profit_and_loss_expenses import ProfitAndLossExpenses + from apideck.model.profit_and_loss_gross_profit import ProfitAndLossGrossProfit + from apideck.model.profit_and_loss_income import ProfitAndLossIncome + from apideck.model.profit_and_loss_net_income import ProfitAndLossNetIncome + from apideck.model.profit_and_loss_net_operating_income import ProfitAndLossNetOperatingIncome + globals()['ProfitAndLossExpenses'] = ProfitAndLossExpenses + globals()['ProfitAndLossGrossProfit'] = ProfitAndLossGrossProfit + globals()['ProfitAndLossIncome'] = ProfitAndLossIncome + globals()['ProfitAndLossNetIncome'] = ProfitAndLossNetIncome + globals()['ProfitAndLossNetOperatingIncome'] = ProfitAndLossNetOperatingIncome + + +class ProfitAndLoss(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + ('start_date',): { + 'regex': { + 'pattern': r'^\d{4}-\d{2}-\d{2}$', # noqa: E501 + }, + }, + ('end_date',): { + 'regex': { + 'pattern': r'^\d{4}-\d{2}-\d{2}$', # noqa: E501 + }, + }, + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'report_name': (str,), # noqa: E501 + 'currency': (str,), # noqa: E501 + 'income': (ProfitAndLossIncome,), # noqa: E501 + 'expenses': (ProfitAndLossExpenses,), # noqa: E501 + 'id': (str,), # noqa: E501 + 'start_date': (str,), # noqa: E501 + 'end_date': (str,), # noqa: E501 + 'customer_id': (str,), # noqa: E501 + 'net_income': (ProfitAndLossNetIncome,), # noqa: E501 + 'net_operating_income': (ProfitAndLossNetOperatingIncome,), # noqa: E501 + 'gross_profit': (ProfitAndLossGrossProfit,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'report_name': 'report_name', # noqa: E501 + 'currency': 'currency', # noqa: E501 + 'income': 'income', # noqa: E501 + 'expenses': 'expenses', # noqa: E501 + 'id': 'id', # noqa: E501 + 'start_date': 'start_date', # noqa: E501 + 'end_date': 'end_date', # noqa: E501 + 'customer_id': 'customer_id', # noqa: E501 + 'net_income': 'net_income', # noqa: E501 + 'net_operating_income': 'net_operating_income', # noqa: E501 + 'gross_profit': 'gross_profit', # noqa: E501 + } + + read_only_vars = { + 'id', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, report_name, currency, income, expenses, *args, **kwargs): # noqa: E501 + """ProfitAndLoss - a model defined in OpenAPI + + Args: + report_name (str): The name of the report + currency (str): + income (ProfitAndLossIncome): + expenses (ProfitAndLossExpenses): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + start_date (str): The start date of the report. [optional] # noqa: E501 + end_date (str): The start date of the report. [optional] # noqa: E501 + customer_id (str): Customer id. [optional] # noqa: E501 + net_income (ProfitAndLossNetIncome): [optional] # noqa: E501 + net_operating_income (ProfitAndLossNetOperatingIncome): [optional] # noqa: E501 + gross_profit (ProfitAndLossGrossProfit): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.report_name = report_name + self.currency = currency + self.income = income + self.expenses = expenses + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, report_name, currency, income, expenses, *args, **kwargs): # noqa: E501 + """ProfitAndLoss - a model defined in OpenAPI + + Args: + report_name (str): The name of the report + currency (str): + income (ProfitAndLossIncome): + expenses (ProfitAndLossExpenses): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + start_date (str): The start date of the report. [optional] # noqa: E501 + end_date (str): The start date of the report. [optional] # noqa: E501 + customer_id (str): Customer id. [optional] # noqa: E501 + net_income (ProfitAndLossNetIncome): [optional] # noqa: E501 + net_operating_income (ProfitAndLossNetOperatingIncome): [optional] # noqa: E501 + gross_profit (ProfitAndLossGrossProfit): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.report_name = report_name + self.currency = currency + self.income = income + self.expenses = expenses + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/profit_and_loss_expenses.py b/src/apideck/model/profit_and_loss_expenses.py new file mode 100644 index 0000000000..bd7f21e243 --- /dev/null +++ b/src/apideck/model/profit_and_loss_expenses.py @@ -0,0 +1,273 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.profit_and_loss_records import ProfitAndLossRecords + globals()['ProfitAndLossRecords'] = ProfitAndLossRecords + + +class ProfitAndLossExpenses(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'total': (float, none_type,), # noqa: E501 + 'records': (ProfitAndLossRecords,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'total': 'total', # noqa: E501 + 'records': 'records', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, total, records, *args, **kwargs): # noqa: E501 + """ProfitAndLossExpenses - a model defined in OpenAPI + + Args: + total (float, none_type): Total expense + records (ProfitAndLossRecords): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.total = total + self.records = records + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, total, records, *args, **kwargs): # noqa: E501 + """ProfitAndLossExpenses - a model defined in OpenAPI + + Args: + total (float, none_type): Total expense + records (ProfitAndLossRecords): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.total = total + self.records = records + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/profit_and_loss_filter.py b/src/apideck/model/profit_and_loss_filter.py new file mode 100644 index 0000000000..c4478eb3eb --- /dev/null +++ b/src/apideck/model/profit_and_loss_filter.py @@ -0,0 +1,257 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class ProfitAndLossFilter(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'customer_id': (str,), # noqa: E501 + 'start_date': (str,), # noqa: E501 + 'end_date': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'customer_id': 'customer_id', # noqa: E501 + 'start_date': 'start_date', # noqa: E501 + 'end_date': 'end_date', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ProfitAndLossFilter - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + customer_id (str): Filter by customer id. [optional] # noqa: E501 + start_date (str): Filter by start date. If start date is given, end date is required.. [optional] # noqa: E501 + end_date (str): Filter by end date. If end date is given, start date is required.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """ProfitAndLossFilter - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + customer_id (str): Filter by customer id. [optional] # noqa: E501 + start_date (str): Filter by start date. If start date is given, end date is required.. [optional] # noqa: E501 + end_date (str): Filter by end date. If end date is given, start date is required.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/profit_and_loss_gross_profit.py b/src/apideck/model/profit_and_loss_gross_profit.py new file mode 100644 index 0000000000..a960148d6d --- /dev/null +++ b/src/apideck/model/profit_and_loss_gross_profit.py @@ -0,0 +1,273 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.profit_and_loss_records import ProfitAndLossRecords + globals()['ProfitAndLossRecords'] = ProfitAndLossRecords + + +class ProfitAndLossGrossProfit(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = True + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'total': (float, none_type,), # noqa: E501 + 'records': (ProfitAndLossRecords,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'total': 'total', # noqa: E501 + 'records': 'records', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, total, records, *args, **kwargs): # noqa: E501 + """ProfitAndLossGrossProfit - a model defined in OpenAPI + + Args: + total (float, none_type): Total gross profit + records (ProfitAndLossRecords): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.total = total + self.records = records + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, total, records, *args, **kwargs): # noqa: E501 + """ProfitAndLossGrossProfit - a model defined in OpenAPI + + Args: + total (float, none_type): Total gross profit + records (ProfitAndLossRecords): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.total = total + self.records = records + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/profit_and_loss_income.py b/src/apideck/model/profit_and_loss_income.py new file mode 100644 index 0000000000..1edac7f220 --- /dev/null +++ b/src/apideck/model/profit_and_loss_income.py @@ -0,0 +1,273 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.profit_and_loss_records import ProfitAndLossRecords + globals()['ProfitAndLossRecords'] = ProfitAndLossRecords + + +class ProfitAndLossIncome(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'total': (float, none_type,), # noqa: E501 + 'records': (ProfitAndLossRecords,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'total': 'total', # noqa: E501 + 'records': 'records', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, total, records, *args, **kwargs): # noqa: E501 + """ProfitAndLossIncome - a model defined in OpenAPI + + Args: + total (float, none_type): Total income + records (ProfitAndLossRecords): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.total = total + self.records = records + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, total, records, *args, **kwargs): # noqa: E501 + """ProfitAndLossIncome - a model defined in OpenAPI + + Args: + total (float, none_type): Total income + records (ProfitAndLossRecords): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.total = total + self.records = records + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/profit_and_loss_net_income.py b/src/apideck/model/profit_and_loss_net_income.py new file mode 100644 index 0000000000..ad0f74d4ca --- /dev/null +++ b/src/apideck/model/profit_and_loss_net_income.py @@ -0,0 +1,273 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.profit_and_loss_records import ProfitAndLossRecords + globals()['ProfitAndLossRecords'] = ProfitAndLossRecords + + +class ProfitAndLossNetIncome(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = True + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'total': (float, none_type,), # noqa: E501 + 'records': (ProfitAndLossRecords,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'total': 'total', # noqa: E501 + 'records': 'records', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, total, records, *args, **kwargs): # noqa: E501 + """ProfitAndLossNetIncome - a model defined in OpenAPI + + Args: + total (float, none_type): Total net income + records (ProfitAndLossRecords): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.total = total + self.records = records + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, total, records, *args, **kwargs): # noqa: E501 + """ProfitAndLossNetIncome - a model defined in OpenAPI + + Args: + total (float, none_type): Total net income + records (ProfitAndLossRecords): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.total = total + self.records = records + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/profit_and_loss_net_operating_income.py b/src/apideck/model/profit_and_loss_net_operating_income.py new file mode 100644 index 0000000000..b98eb46d07 --- /dev/null +++ b/src/apideck/model/profit_and_loss_net_operating_income.py @@ -0,0 +1,273 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.profit_and_loss_records import ProfitAndLossRecords + globals()['ProfitAndLossRecords'] = ProfitAndLossRecords + + +class ProfitAndLossNetOperatingIncome(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = True + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'total': (float, none_type,), # noqa: E501 + 'records': (ProfitAndLossRecords,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'total': 'total', # noqa: E501 + 'records': 'records', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, total, records, *args, **kwargs): # noqa: E501 + """ProfitAndLossNetOperatingIncome - a model defined in OpenAPI + + Args: + total (float, none_type): Total net operating income + records (ProfitAndLossRecords): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.total = total + self.records = records + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, total, records, *args, **kwargs): # noqa: E501 + """ProfitAndLossNetOperatingIncome - a model defined in OpenAPI + + Args: + total (float, none_type): Total net operating income + records (ProfitAndLossRecords): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.total = total + self.records = records + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/profit_and_loss_record.py b/src/apideck/model/profit_and_loss_record.py new file mode 100644 index 0000000000..eff88a947c --- /dev/null +++ b/src/apideck/model/profit_and_loss_record.py @@ -0,0 +1,273 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class ProfitAndLossRecord(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'type': (str,), # noqa: E501 + 'id': (str, none_type,), # noqa: E501 + 'title': (str, none_type,), # noqa: E501 + 'value': (float, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'type': 'type', # noqa: E501 + 'id': 'id', # noqa: E501 + 'title': 'title', # noqa: E501 + 'value': 'value', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, type, *args, **kwargs): # noqa: E501 + """ProfitAndLossRecord - a model defined in OpenAPI + + Args: + type (str): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str, none_type): [optional] # noqa: E501 + title (str, none_type): [optional] # noqa: E501 + value (float, none_type): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.type = type + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, type, *args, **kwargs): # noqa: E501 + """ProfitAndLossRecord - a model defined in OpenAPI + + Args: + type (str): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str, none_type): [optional] # noqa: E501 + title (str, none_type): [optional] # noqa: E501 + value (float, none_type): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.type = type + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/profit_and_loss_records.py b/src/apideck/model/profit_and_loss_records.py new file mode 100644 index 0000000000..66032492e7 --- /dev/null +++ b/src/apideck/model/profit_and_loss_records.py @@ -0,0 +1,278 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class ProfitAndLossRecords(ModelSimple): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = True + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'value': ([bool, date, datetime, dict, float, int, list, str, none_type], none_type,), + } + + @cached_property + def discriminator(): + return None + + + attribute_map = {} + + read_only_vars = set() + + _composed_schemas = None + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): + """ProfitAndLossRecords - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] ([bool, date, datetime, dict, float, int, list, str, none_type], none_type): # noqa: E501 + + Keyword Args: + value ([bool, date, datetime, dict, float, int, list, str, none_type], none_type): # noqa: E501 + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + self.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): + """ProfitAndLossRecords - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] ([bool, date, datetime, dict, float, int, list, str, none_type], none_type): # noqa: E501 + + Keyword Args: + value ([bool, date, datetime, dict, float, int, list, str, none_type], none_type): # noqa: E501 + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + self.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + return self diff --git a/src/apideck/model/profit_and_loss_section.py b/src/apideck/model/profit_and_loss_section.py new file mode 100644 index 0000000000..3a1824a6a1 --- /dev/null +++ b/src/apideck/model/profit_and_loss_section.py @@ -0,0 +1,283 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.profit_and_loss_records import ProfitAndLossRecords + globals()['ProfitAndLossRecords'] = ProfitAndLossRecords + + +class ProfitAndLossSection(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'type': (str,), # noqa: E501 + 'id': (str, none_type,), # noqa: E501 + 'title': (str, none_type,), # noqa: E501 + 'total': (float, none_type,), # noqa: E501 + 'records': (ProfitAndLossRecords,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'type': 'type', # noqa: E501 + 'id': 'id', # noqa: E501 + 'title': 'title', # noqa: E501 + 'total': 'total', # noqa: E501 + 'records': 'records', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, type, *args, **kwargs): # noqa: E501 + """ProfitAndLossSection - a model defined in OpenAPI + + Args: + type (str): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str, none_type): [optional] # noqa: E501 + title (str, none_type): [optional] # noqa: E501 + total (float, none_type): [optional] # noqa: E501 + records (ProfitAndLossRecords): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.type = type + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, type, *args, **kwargs): # noqa: E501 + """ProfitAndLossSection - a model defined in OpenAPI + + Args: + type (str): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str, none_type): [optional] # noqa: E501 + title (str, none_type): [optional] # noqa: E501 + total (float, none_type): [optional] # noqa: E501 + records (ProfitAndLossRecords): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.type = type + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/request_count_allocation.py b/src/apideck/model/request_count_allocation.py new file mode 100644 index 0000000000..94b154bfc3 --- /dev/null +++ b/src/apideck/model/request_count_allocation.py @@ -0,0 +1,263 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class RequestCountAllocation(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'unify': (float,), # noqa: E501 + 'proxy': (float,), # noqa: E501 + 'vault': (float,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'unify': 'unify', # noqa: E501 + 'proxy': 'proxy', # noqa: E501 + 'vault': 'vault', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """RequestCountAllocation - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + unify (float): [optional] # noqa: E501 + proxy (float): [optional] # noqa: E501 + vault (float): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """RequestCountAllocation - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + unify (float): [optional] # noqa: E501 + proxy (float): [optional] # noqa: E501 + vault (float): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/resolve_webhook_event_request.py b/src/apideck/model/resolve_webhook_event_request.py new file mode 100644 index 0000000000..d6f23d003c --- /dev/null +++ b/src/apideck/model/resolve_webhook_event_request.py @@ -0,0 +1,251 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class ResolveWebhookEventRequest(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ResolveWebhookEventRequest - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """ResolveWebhookEventRequest - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/resolve_webhook_events_request.py b/src/apideck/model/resolve_webhook_events_request.py new file mode 100644 index 0000000000..e5ba77d494 --- /dev/null +++ b/src/apideck/model/resolve_webhook_events_request.py @@ -0,0 +1,278 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class ResolveWebhookEventsRequest(ModelSimple): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'value': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), + } + + @cached_property + def discriminator(): + return None + + + attribute_map = {} + + read_only_vars = set() + + _composed_schemas = None + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): + """ResolveWebhookEventsRequest - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]): # noqa: E501 + + Keyword Args: + value ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]): # noqa: E501 + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + self.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): + """ResolveWebhookEventsRequest - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]): # noqa: E501 + + Keyword Args: + value ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]): # noqa: E501 + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + self.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + return self diff --git a/src/apideck/model/resolve_webhook_response.py b/src/apideck/model/resolve_webhook_response.py new file mode 100644 index 0000000000..ed89b9ffc8 --- /dev/null +++ b/src/apideck/model/resolve_webhook_response.py @@ -0,0 +1,275 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class ResolveWebhookResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'request_id': (str,), # noqa: E501 + 'timestamp': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'request_id': 'request_id', # noqa: E501 + 'timestamp': 'timestamp', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, *args, **kwargs): # noqa: E501 + """ResolveWebhookResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + request_id (str): UUID of the request received. [optional] # noqa: E501 + timestamp (str): ISO Datetime webhook event was received. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, *args, **kwargs): # noqa: E501 + """ResolveWebhookResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + request_id (str): UUID of the request received. [optional] # noqa: E501 + timestamp (str): ISO Datetime webhook event was received. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/resource_status.py b/src/apideck/model/resource_status.py new file mode 100644 index 0000000000..4cea981549 --- /dev/null +++ b/src/apideck/model/resource_status.py @@ -0,0 +1,285 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class ResourceStatus(ModelSimple): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('value',): { + 'LIVE': "live", + 'BETA': "beta", + 'DEVELOPMENT': "development", + 'UPCOMING': "upcoming", + 'CONSIDERING': "considering", + }, + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'value': (str,), + } + + @cached_property + def discriminator(): + return None + + + attribute_map = {} + + read_only_vars = set() + + _composed_schemas = None + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): + """ResourceStatus - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] (str): Status of the resource. Resources with status live or beta are callable.., must be one of ["live", "beta", "development", "upcoming", "considering", ] # noqa: E501 + + Keyword Args: + value (str): Status of the resource. Resources with status live or beta are callable.., must be one of ["live", "beta", "development", "upcoming", "considering", ] # noqa: E501 + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + self.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): + """ResourceStatus - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] (str): Status of the resource. Resources with status live or beta are callable.., must be one of ["live", "beta", "development", "upcoming", "considering", ] # noqa: E501 + + Keyword Args: + value (str): Status of the resource. Resources with status live or beta are callable.., must be one of ["live", "beta", "development", "upcoming", "considering", ] # noqa: E501 + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + self.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + return self diff --git a/src/apideck/model/schedule.py b/src/apideck/model/schedule.py new file mode 100644 index 0000000000..ddae9e8750 --- /dev/null +++ b/src/apideck/model/schedule.py @@ -0,0 +1,286 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.schedule_work_pattern import ScheduleWorkPattern + globals()['ScheduleWorkPattern'] = ScheduleWorkPattern + + +class Schedule(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + ('start_date',): { + 'regex': { + 'pattern': r'^\d{4}-\d{2}-\d{2}$', # noqa: E501 + }, + }, + ('end_date',): { + 'regex': { + 'pattern': r'^\d{4}-\d{2}-\d{2}$', # noqa: E501 + }, + }, + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'id': (str,), # noqa: E501 + 'start_date': (str,), # noqa: E501 + 'end_date': (str,), # noqa: E501 + 'work_pattern': (ScheduleWorkPattern,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'start_date': 'start_date', # noqa: E501 + 'end_date': 'end_date', # noqa: E501 + 'work_pattern': 'work_pattern', # noqa: E501 + } + + read_only_vars = { + 'id', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, id, start_date, end_date, work_pattern, *args, **kwargs): # noqa: E501 + """Schedule - a model defined in OpenAPI + + Args: + id (str): + start_date (str): The start date, inclusive, of the schedule period. + end_date (str): The end date, inclusive, of the schedule period. + work_pattern (ScheduleWorkPattern): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.id = id + self.start_date = start_date + self.end_date = end_date + self.work_pattern = work_pattern + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, start_date, end_date, work_pattern, *args, **kwargs): # noqa: E501 + """Schedule - a model defined in OpenAPI + + start_date (str): The start date, inclusive, of the schedule period. + end_date (str): The end date, inclusive, of the schedule period. + work_pattern (ScheduleWorkPattern): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.start_date = start_date + self.end_date = end_date + self.work_pattern = work_pattern + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/schedule_work_pattern.py b/src/apideck/model/schedule_work_pattern.py new file mode 100644 index 0000000000..469c18c095 --- /dev/null +++ b/src/apideck/model/schedule_work_pattern.py @@ -0,0 +1,265 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.schedule_work_pattern_odd_weeks import ScheduleWorkPatternOddWeeks + globals()['ScheduleWorkPatternOddWeeks'] = ScheduleWorkPatternOddWeeks + + +class ScheduleWorkPattern(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'odd_weeks': (ScheduleWorkPatternOddWeeks,), # noqa: E501 + 'even_weeks': (ScheduleWorkPatternOddWeeks,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'odd_weeks': 'odd_weeks', # noqa: E501 + 'even_weeks': 'even_weeks', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ScheduleWorkPattern - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + odd_weeks (ScheduleWorkPatternOddWeeks): [optional] # noqa: E501 + even_weeks (ScheduleWorkPatternOddWeeks): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """ScheduleWorkPattern - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + odd_weeks (ScheduleWorkPatternOddWeeks): [optional] # noqa: E501 + even_weeks (ScheduleWorkPatternOddWeeks): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/schedule_work_pattern_odd_weeks.py b/src/apideck/model/schedule_work_pattern_odd_weeks.py new file mode 100644 index 0000000000..db919120b5 --- /dev/null +++ b/src/apideck/model/schedule_work_pattern_odd_weeks.py @@ -0,0 +1,307 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class ScheduleWorkPatternOddWeeks(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + ('hours_monday',): { + 'inclusive_maximum': 24, + 'inclusive_minimum': 0, + }, + ('hours_tuesday',): { + 'inclusive_maximum': 24, + 'inclusive_minimum': 0, + }, + ('hours_wednesday',): { + 'inclusive_maximum': 24, + 'inclusive_minimum': 0, + }, + ('hours_thursday',): { + 'inclusive_maximum': 24, + 'inclusive_minimum': 0, + }, + ('hours_friday',): { + 'inclusive_maximum': 24, + 'inclusive_minimum': 0, + }, + ('hours_saturday',): { + 'inclusive_maximum': 24, + 'inclusive_minimum': 0, + }, + ('hours_sunday',): { + 'inclusive_maximum': 24, + 'inclusive_minimum': 0, + }, + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'hours_monday': (float,), # noqa: E501 + 'hours_tuesday': (float,), # noqa: E501 + 'hours_wednesday': (float,), # noqa: E501 + 'hours_thursday': (float,), # noqa: E501 + 'hours_friday': (float,), # noqa: E501 + 'hours_saturday': (float,), # noqa: E501 + 'hours_sunday': (float,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'hours_monday': 'hours_monday', # noqa: E501 + 'hours_tuesday': 'hours_tuesday', # noqa: E501 + 'hours_wednesday': 'hours_wednesday', # noqa: E501 + 'hours_thursday': 'hours_thursday', # noqa: E501 + 'hours_friday': 'hours_friday', # noqa: E501 + 'hours_saturday': 'hours_saturday', # noqa: E501 + 'hours_sunday': 'hours_sunday', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ScheduleWorkPatternOddWeeks - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + hours_monday (float): [optional] # noqa: E501 + hours_tuesday (float): [optional] # noqa: E501 + hours_wednesday (float): [optional] # noqa: E501 + hours_thursday (float): [optional] # noqa: E501 + hours_friday (float): [optional] # noqa: E501 + hours_saturday (float): [optional] # noqa: E501 + hours_sunday (float): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """ScheduleWorkPatternOddWeeks - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + hours_monday (float): [optional] # noqa: E501 + hours_tuesday (float): [optional] # noqa: E501 + hours_wednesday (float): [optional] # noqa: E501 + hours_thursday (float): [optional] # noqa: E501 + hours_friday (float): [optional] # noqa: E501 + hours_saturday (float): [optional] # noqa: E501 + hours_sunday (float): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/service_charge.py b/src/apideck/model/service_charge.py new file mode 100644 index 0000000000..ded5790a30 --- /dev/null +++ b/src/apideck/model/service_charge.py @@ -0,0 +1,290 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.currency import Currency + globals()['Currency'] = Currency + + +class ServiceCharge(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('type',): { + 'AUTO_GRATUITY': "auto_gratuity", + 'CUSTOM': "custom", + }, + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'id': (str,), # noqa: E501 + 'name': (str,), # noqa: E501 + 'amount': (float,), # noqa: E501 + 'percentage': (float,), # noqa: E501 + 'currency': (Currency,), # noqa: E501 + 'active': (bool, none_type,), # noqa: E501 + 'type': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'name': 'name', # noqa: E501 + 'amount': 'amount', # noqa: E501 + 'percentage': 'percentage', # noqa: E501 + 'currency': 'currency', # noqa: E501 + 'active': 'active', # noqa: E501 + 'type': 'type', # noqa: E501 + } + + read_only_vars = { + 'id', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ServiceCharge - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + name (str): Service charge name. [optional] # noqa: E501 + amount (float): [optional] # noqa: E501 + percentage (float): Service charge percentage. Use this field to calculate the amount of the service charge. Pass a percentage and amount at the same time.. [optional] # noqa: E501 + currency (Currency): [optional] # noqa: E501 + active (bool, none_type): [optional] # noqa: E501 + type (str): The type of the service charge.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """ServiceCharge - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + name (str): Service charge name. [optional] # noqa: E501 + amount (float): [optional] # noqa: E501 + percentage (float): Service charge percentage. Use this field to calculate the amount of the service charge. Pass a percentage and amount at the same time.. [optional] # noqa: E501 + currency (Currency): [optional] # noqa: E501 + active (bool, none_type): [optional] # noqa: E501 + type (str): The type of the service charge.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/service_charges.py b/src/apideck/model/service_charges.py new file mode 100644 index 0000000000..b4dea3eb4d --- /dev/null +++ b/src/apideck/model/service_charges.py @@ -0,0 +1,283 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.service_charge import ServiceCharge + globals()['ServiceCharge'] = ServiceCharge + + +class ServiceCharges(ModelSimple): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'value': ([ServiceCharge],), + } + + @cached_property + def discriminator(): + return None + + + attribute_map = {} + + read_only_vars = set() + + _composed_schemas = None + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): + """ServiceCharges - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] ([ServiceCharge]): Optional service charges or gratuity tip applied to the order.. # noqa: E501 + + Keyword Args: + value ([ServiceCharge]): Optional service charges or gratuity tip applied to the order.. # noqa: E501 + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + self.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): + """ServiceCharges - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] ([ServiceCharge]): Optional service charges or gratuity tip applied to the order.. # noqa: E501 + + Keyword Args: + value ([ServiceCharge]): Optional service charges or gratuity tip applied to the order.. # noqa: E501 + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + self.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + return self diff --git a/src/apideck/model/session.py b/src/apideck/model/session.py new file mode 100644 index 0000000000..3dc3283b88 --- /dev/null +++ b/src/apideck/model/session.py @@ -0,0 +1,274 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.consumer_metadata import ConsumerMetadata + from apideck.model.session_settings import SessionSettings + from apideck.model.session_theme import SessionTheme + globals()['ConsumerMetadata'] = ConsumerMetadata + globals()['SessionSettings'] = SessionSettings + globals()['SessionTheme'] = SessionTheme + + +class Session(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'consumer_metadata': (ConsumerMetadata,), # noqa: E501 + 'custom_consumer_settings': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), # noqa: E501 + 'redirect_uri': (str,), # noqa: E501 + 'settings': (SessionSettings,), # noqa: E501 + 'theme': (SessionTheme,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'consumer_metadata': 'consumer_metadata', # noqa: E501 + 'custom_consumer_settings': 'custom_consumer_settings', # noqa: E501 + 'redirect_uri': 'redirect_uri', # noqa: E501 + 'settings': 'settings', # noqa: E501 + 'theme': 'theme', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """Session - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + consumer_metadata (ConsumerMetadata): [optional] # noqa: E501 + custom_consumer_settings ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Custom consumer settings that are passed as part of the session.. [optional] # noqa: E501 + redirect_uri (str): [optional] # noqa: E501 + settings (SessionSettings): [optional] # noqa: E501 + theme (SessionTheme): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """Session - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + consumer_metadata (ConsumerMetadata): [optional] # noqa: E501 + custom_consumer_settings ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Custom consumer settings that are passed as part of the session.. [optional] # noqa: E501 + redirect_uri (str): [optional] # noqa: E501 + settings (SessionSettings): [optional] # noqa: E501 + theme (SessionTheme): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/session_settings.py b/src/apideck/model/session_settings.py new file mode 100644 index 0000000000..3b013aaa46 --- /dev/null +++ b/src/apideck/model/session_settings.py @@ -0,0 +1,293 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_api_id import UnifiedApiId + globals()['UnifiedApiId'] = UnifiedApiId + + +class SessionSettings(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'unified_apis': ([UnifiedApiId],), # noqa: E501 + 'hide_resource_settings': (bool,), # noqa: E501 + 'sandbox_mode': (bool,), # noqa: E501 + 'isolation_mode': (bool,), # noqa: E501 + 'session_length': (str,), # noqa: E501 + 'show_logs': (bool,), # noqa: E501 + 'show_suggestions': (bool,), # noqa: E501 + 'show_sidebar': (bool,), # noqa: E501 + 'auto_redirect': (bool,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'unified_apis': 'unified_apis', # noqa: E501 + 'hide_resource_settings': 'hide_resource_settings', # noqa: E501 + 'sandbox_mode': 'sandbox_mode', # noqa: E501 + 'isolation_mode': 'isolation_mode', # noqa: E501 + 'session_length': 'session_length', # noqa: E501 + 'show_logs': 'show_logs', # noqa: E501 + 'show_suggestions': 'show_suggestions', # noqa: E501 + 'show_sidebar': 'show_sidebar', # noqa: E501 + 'auto_redirect': 'auto_redirect', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """SessionSettings - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + unified_apis ([UnifiedApiId]): Provide the IDs of the Unified APIs you want to be visible. Leaving it empty or omiting this field will show all Unified APIs.. [optional] # noqa: E501 + hide_resource_settings (bool): [optional] if omitted the server will use the default value of False # noqa: E501 + sandbox_mode (bool): Configure [Vault](/apis/vault/reference#section/Get-Started) to show a banner informing the logged in user is in a test environment.. [optional] if omitted the server will use the default value of False # noqa: E501 + isolation_mode (bool): Configure [Vault](/apis/vault/reference#section/Get-Started) to run in isolation mode, meaning it only shows the connection settings and hides the navigation items.. [optional] if omitted the server will use the default value of False # noqa: E501 + session_length (str): The duration of time the session is valid for (maximum 1 week).. [optional] if omitted the server will use the default value of "1h" # noqa: E501 + show_logs (bool): Configure [Vault](/apis/vault/reference#section/Get-Started) to show the logs page. Defaults to `true`.. [optional] if omitted the server will use the default value of True # noqa: E501 + show_suggestions (bool): Configure [Vault](/apis/vault/reference#section/Get-Started) to show the suggestions page. Defaults to `false`.. [optional] if omitted the server will use the default value of False # noqa: E501 + show_sidebar (bool): Configure [Vault](/apis/vault/reference#section/Get-Started) to show the sidebar. Defaults to `true`.. [optional] if omitted the server will use the default value of True # noqa: E501 + auto_redirect (bool): Automatically redirect to redirect uri after the connection has been configured as callable. Defaults to `false`.. [optional] if omitted the server will use the default value of False # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """SessionSettings - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + unified_apis ([UnifiedApiId]): Provide the IDs of the Unified APIs you want to be visible. Leaving it empty or omiting this field will show all Unified APIs.. [optional] # noqa: E501 + hide_resource_settings (bool): [optional] if omitted the server will use the default value of False # noqa: E501 + sandbox_mode (bool): Configure [Vault](/apis/vault/reference#section/Get-Started) to show a banner informing the logged in user is in a test environment.. [optional] if omitted the server will use the default value of False # noqa: E501 + isolation_mode (bool): Configure [Vault](/apis/vault/reference#section/Get-Started) to run in isolation mode, meaning it only shows the connection settings and hides the navigation items.. [optional] if omitted the server will use the default value of False # noqa: E501 + session_length (str): The duration of time the session is valid for (maximum 1 week).. [optional] if omitted the server will use the default value of "1h" # noqa: E501 + show_logs (bool): Configure [Vault](/apis/vault/reference#section/Get-Started) to show the logs page. Defaults to `true`.. [optional] if omitted the server will use the default value of True # noqa: E501 + show_suggestions (bool): Configure [Vault](/apis/vault/reference#section/Get-Started) to show the suggestions page. Defaults to `false`.. [optional] if omitted the server will use the default value of False # noqa: E501 + show_sidebar (bool): Configure [Vault](/apis/vault/reference#section/Get-Started) to show the sidebar. Defaults to `true`.. [optional] if omitted the server will use the default value of True # noqa: E501 + auto_redirect (bool): Automatically redirect to redirect uri after the connection has been configured as callable. Defaults to `false`.. [optional] if omitted the server will use the default value of False # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/session_theme.py b/src/apideck/model/session_theme.py new file mode 100644 index 0000000000..07bb2e3329 --- /dev/null +++ b/src/apideck/model/session_theme.py @@ -0,0 +1,279 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class SessionTheme(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'favicon': (str,), # noqa: E501 + 'primary_color': (str,), # noqa: E501 + 'privacy_url': (str,), # noqa: E501 + 'sidepanel_background_color': (str,), # noqa: E501 + 'sidepanel_text_color': (str,), # noqa: E501 + 'terms_url': (str,), # noqa: E501 + 'vault_name': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'favicon': 'favicon', # noqa: E501 + 'primary_color': 'primary_color', # noqa: E501 + 'privacy_url': 'privacy_url', # noqa: E501 + 'sidepanel_background_color': 'sidepanel_background_color', # noqa: E501 + 'sidepanel_text_color': 'sidepanel_text_color', # noqa: E501 + 'terms_url': 'terms_url', # noqa: E501 + 'vault_name': 'vault_name', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """SessionTheme - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + favicon (str): [optional] # noqa: E501 + primary_color (str): [optional] # noqa: E501 + privacy_url (str): [optional] # noqa: E501 + sidepanel_background_color (str): [optional] # noqa: E501 + sidepanel_text_color (str): [optional] # noqa: E501 + terms_url (str): [optional] # noqa: E501 + vault_name (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """SessionTheme - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + favicon (str): [optional] # noqa: E501 + primary_color (str): [optional] # noqa: E501 + privacy_url (str): [optional] # noqa: E501 + sidepanel_background_color (str): [optional] # noqa: E501 + sidepanel_text_color (str): [optional] # noqa: E501 + terms_url (str): [optional] # noqa: E501 + vault_name (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/shared_link.py b/src/apideck/model/shared_link.py new file mode 100644 index 0000000000..3c2c3cb541 --- /dev/null +++ b/src/apideck/model/shared_link.py @@ -0,0 +1,305 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.shared_link_target import SharedLinkTarget + globals()['SharedLinkTarget'] = SharedLinkTarget + + +class SharedLink(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('scope',): { + 'PUBLIC': "public", + 'COMPANY': "company", + }, + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'target_id': (str,), # noqa: E501 + 'url': (str,), # noqa: E501 + 'download_url': (str,), # noqa: E501 + 'target': (SharedLinkTarget,), # noqa: E501 + 'scope': (str,), # noqa: E501 + 'password_protected': (bool,), # noqa: E501 + 'password': (str, none_type,), # noqa: E501 + 'expires_at': (datetime,), # noqa: E501 + 'updated_at': (datetime,), # noqa: E501 + 'created_at': (datetime,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'target_id': 'target_id', # noqa: E501 + 'url': 'url', # noqa: E501 + 'download_url': 'download_url', # noqa: E501 + 'target': 'target', # noqa: E501 + 'scope': 'scope', # noqa: E501 + 'password_protected': 'password_protected', # noqa: E501 + 'password': 'password', # noqa: E501 + 'expires_at': 'expires_at', # noqa: E501 + 'updated_at': 'updated_at', # noqa: E501 + 'created_at': 'created_at', # noqa: E501 + } + + read_only_vars = { + 'url', # noqa: E501 + 'password_protected', # noqa: E501 + 'expires_at', # noqa: E501 + 'updated_at', # noqa: E501 + 'created_at', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, target_id, *args, **kwargs): # noqa: E501 + """SharedLink - a model defined in OpenAPI + + Args: + target_id (str): The ID of the file or folder to link. + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + url (str): The URL that can be used to view the file.. [optional] # noqa: E501 + download_url (str): The URL that can be used to download the file.. [optional] # noqa: E501 + target (SharedLinkTarget): [optional] # noqa: E501 + scope (str): The scope of the shared link.. [optional] # noqa: E501 + password_protected (bool): Indicated if the shared link is password protected.. [optional] # noqa: E501 + password (str, none_type): Optional password for the shared link.. [optional] # noqa: E501 + expires_at (datetime): [optional] # noqa: E501 + updated_at (datetime): [optional] # noqa: E501 + created_at (datetime): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.target_id = target_id + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, target_id, *args, **kwargs): # noqa: E501 + """SharedLink - a model defined in OpenAPI + + Args: + target_id (str): The ID of the file or folder to link. + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + url (str): The URL that can be used to view the file.. [optional] # noqa: E501 + download_url (str): The URL that can be used to download the file.. [optional] # noqa: E501 + target (SharedLinkTarget): [optional] # noqa: E501 + scope (str): The scope of the shared link.. [optional] # noqa: E501 + password_protected (bool): Indicated if the shared link is password protected.. [optional] # noqa: E501 + password (str, none_type): Optional password for the shared link.. [optional] # noqa: E501 + expires_at (datetime): [optional] # noqa: E501 + updated_at (datetime): [optional] # noqa: E501 + created_at (datetime): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.target_id = target_id + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/shared_link_target.py b/src/apideck/model/shared_link_target.py new file mode 100644 index 0000000000..fcbeb46341 --- /dev/null +++ b/src/apideck/model/shared_link_target.py @@ -0,0 +1,265 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.file_type import FileType + globals()['FileType'] = FileType + + +class SharedLinkTarget(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'id': (str,), # noqa: E501 + 'name': (str,), # noqa: E501 + 'type': (FileType,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'name': 'name', # noqa: E501 + 'type': 'type', # noqa: E501 + } + + read_only_vars = { + 'id', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 + """SharedLinkTarget - a model defined in OpenAPI + + Args: + id (str): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + name (str): The name of the file. [optional] # noqa: E501 + type (FileType): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.id = id + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """SharedLinkTarget - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + name (str): The name of the file. [optional] # noqa: E501 + type (FileType): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/simple_form_field_option.py b/src/apideck/model/simple_form_field_option.py new file mode 100644 index 0000000000..d4c614d6c1 --- /dev/null +++ b/src/apideck/model/simple_form_field_option.py @@ -0,0 +1,259 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class SimpleFormFieldOption(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'label': (str,), # noqa: E501 + 'value': (bool, date, datetime, dict, float, int, list, str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'label': 'label', # noqa: E501 + 'value': 'value', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """SimpleFormFieldOption - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + label (str): [optional] # noqa: E501 + value (bool, date, datetime, dict, float, int, list, str, none_type): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """SimpleFormFieldOption - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + label (str): [optional] # noqa: E501 + value (bool, date, datetime, dict, float, int, list, str, none_type): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/social_link.py b/src/apideck/model/social_link.py new file mode 100644 index 0000000000..9bd351a969 --- /dev/null +++ b/src/apideck/model/social_link.py @@ -0,0 +1,266 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class SocialLink(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + ('url',): { + 'min_length': 1, + }, + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'url': (str,), # noqa: E501 + 'id': (str, none_type,), # noqa: E501 + 'type': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'url': 'url', # noqa: E501 + 'id': 'id', # noqa: E501 + 'type': 'type', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, url, *args, **kwargs): # noqa: E501 + """SocialLink - a model defined in OpenAPI + + Args: + url (str): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str, none_type): [optional] # noqa: E501 + type (str, none_type): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.url = url + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, url, *args, **kwargs): # noqa: E501 + """SocialLink - a model defined in OpenAPI + + Args: + url (str): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str, none_type): [optional] # noqa: E501 + type (str, none_type): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.url = url + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/sort_direction.py b/src/apideck/model/sort_direction.py new file mode 100644 index 0000000000..8575ba21fa --- /dev/null +++ b/src/apideck/model/sort_direction.py @@ -0,0 +1,274 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class SortDirection(ModelSimple): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('value',): { + 'ASC': "asc", + 'DESC': "desc", + }, + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'value': (str,), + } + + @cached_property + def discriminator(): + return None + + + attribute_map = {} + + read_only_vars = set() + + _composed_schemas = None + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): + """SortDirection - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] (str): The direction in which to sort the results. if omitted defaults to "asc", must be one of ["asc", "desc", ] # noqa: E501 + + Keyword Args: + value (str): The direction in which to sort the results. if omitted defaults to "asc", must be one of ["asc", "desc", ] # noqa: E501 + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + value = "asc" + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + self.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): + """SortDirection - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] (str): The direction in which to sort the results. if omitted defaults to "asc", must be one of ["asc", "desc", ] # noqa: E501 + + Keyword Args: + value (str): The direction in which to sort the results. if omitted defaults to "asc", must be one of ["asc", "desc", ] # noqa: E501 + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + value = "asc" + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + self.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + return self diff --git a/src/apideck/model/status.py b/src/apideck/model/status.py new file mode 100644 index 0000000000..f691eac94c --- /dev/null +++ b/src/apideck/model/status.py @@ -0,0 +1,282 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class Status(ModelSimple): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('value',): { + 'ENABLED': "enabled", + 'DISABLED': "disabled", + }, + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'value': (str,), + } + + @cached_property + def discriminator(): + return None + + + attribute_map = {} + + read_only_vars = set() + + _composed_schemas = None + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): + """Status - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] (str): The status of the webhook.., must be one of ["enabled", "disabled", ] # noqa: E501 + + Keyword Args: + value (str): The status of the webhook.., must be one of ["enabled", "disabled", ] # noqa: E501 + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + self.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): + """Status - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] (str): The status of the webhook.., must be one of ["enabled", "disabled", ] # noqa: E501 + + Keyword Args: + value (str): The status of the webhook.., must be one of ["enabled", "disabled", ] # noqa: E501 + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + self.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + return self diff --git a/src/apideck/model/supplier.py b/src/apideck/model/supplier.py new file mode 100644 index 0000000000..50bc796237 --- /dev/null +++ b/src/apideck/model/supplier.py @@ -0,0 +1,385 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.address import Address + from apideck.model.bank_account import BankAccount + from apideck.model.currency import Currency + from apideck.model.email import Email + from apideck.model.linked_ledger_account import LinkedLedgerAccount + from apideck.model.linked_tax_rate import LinkedTaxRate + from apideck.model.phone_number import PhoneNumber + from apideck.model.website import Website + globals()['Address'] = Address + globals()['BankAccount'] = BankAccount + globals()['Currency'] = Currency + globals()['Email'] = Email + globals()['LinkedLedgerAccount'] = LinkedLedgerAccount + globals()['LinkedTaxRate'] = LinkedTaxRate + globals()['PhoneNumber'] = PhoneNumber + globals()['Website'] = Website + + +class Supplier(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('status',): { + 'None': None, + 'ACTIVE': "active", + 'INACTIVE': "inactive", + 'ARCHIVED': "archived", + 'GDPR-ERASURE-REQUEST': "gdpr-erasure-request", + 'UNKNOWN': "unknown", + }, + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'id': (str,), # noqa: E501 + 'downstream_id': (str, none_type,), # noqa: E501 + 'company_name': (str, none_type,), # noqa: E501 + 'display_name': (str, none_type,), # noqa: E501 + 'title': (str, none_type,), # noqa: E501 + 'first_name': (str, none_type,), # noqa: E501 + 'middle_name': (str, none_type,), # noqa: E501 + 'last_name': (str, none_type,), # noqa: E501 + 'suffix': (str, none_type,), # noqa: E501 + 'addresses': ([Address],), # noqa: E501 + 'notes': (str, none_type,), # noqa: E501 + 'phone_numbers': ([PhoneNumber],), # noqa: E501 + 'emails': ([Email],), # noqa: E501 + 'websites': ([Website],), # noqa: E501 + 'bank_accounts': ([BankAccount],), # noqa: E501 + 'tax_rate': (LinkedTaxRate,), # noqa: E501 + 'tax_number': (str, none_type,), # noqa: E501 + 'currency': (Currency,), # noqa: E501 + 'account': (LinkedLedgerAccount,), # noqa: E501 + 'status': (str, none_type,), # noqa: E501 + 'updated_by': (str, none_type,), # noqa: E501 + 'created_by': (str, none_type,), # noqa: E501 + 'updated_at': (datetime,), # noqa: E501 + 'created_at': (datetime,), # noqa: E501 + 'row_version': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'downstream_id': 'downstream_id', # noqa: E501 + 'company_name': 'company_name', # noqa: E501 + 'display_name': 'display_name', # noqa: E501 + 'title': 'title', # noqa: E501 + 'first_name': 'first_name', # noqa: E501 + 'middle_name': 'middle_name', # noqa: E501 + 'last_name': 'last_name', # noqa: E501 + 'suffix': 'suffix', # noqa: E501 + 'addresses': 'addresses', # noqa: E501 + 'notes': 'notes', # noqa: E501 + 'phone_numbers': 'phone_numbers', # noqa: E501 + 'emails': 'emails', # noqa: E501 + 'websites': 'websites', # noqa: E501 + 'bank_accounts': 'bank_accounts', # noqa: E501 + 'tax_rate': 'tax_rate', # noqa: E501 + 'tax_number': 'tax_number', # noqa: E501 + 'currency': 'currency', # noqa: E501 + 'account': 'account', # noqa: E501 + 'status': 'status', # noqa: E501 + 'updated_by': 'updated_by', # noqa: E501 + 'created_by': 'created_by', # noqa: E501 + 'updated_at': 'updated_at', # noqa: E501 + 'created_at': 'created_at', # noqa: E501 + 'row_version': 'row_version', # noqa: E501 + } + + read_only_vars = { + 'id', # noqa: E501 + 'downstream_id', # noqa: E501 + 'updated_by', # noqa: E501 + 'created_by', # noqa: E501 + 'updated_at', # noqa: E501 + 'created_at', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """Supplier - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + downstream_id (str, none_type): The third-party API ID of original entity. [optional] # noqa: E501 + company_name (str, none_type): [optional] # noqa: E501 + display_name (str, none_type): Display name of supplier.. [optional] # noqa: E501 + title (str, none_type): [optional] # noqa: E501 + first_name (str, none_type): [optional] # noqa: E501 + middle_name (str, none_type): [optional] # noqa: E501 + last_name (str, none_type): [optional] # noqa: E501 + suffix (str, none_type): [optional] # noqa: E501 + addresses ([Address]): [optional] # noqa: E501 + notes (str, none_type): [optional] # noqa: E501 + phone_numbers ([PhoneNumber]): [optional] # noqa: E501 + emails ([Email]): [optional] # noqa: E501 + websites ([Website]): [optional] # noqa: E501 + bank_accounts ([BankAccount]): [optional] # noqa: E501 + tax_rate (LinkedTaxRate): [optional] # noqa: E501 + tax_number (str, none_type): [optional] # noqa: E501 + currency (Currency): [optional] # noqa: E501 + account (LinkedLedgerAccount): [optional] # noqa: E501 + status (str, none_type): Customer status. [optional] # noqa: E501 + updated_by (str, none_type): [optional] # noqa: E501 + created_by (str, none_type): [optional] # noqa: E501 + updated_at (datetime): [optional] # noqa: E501 + created_at (datetime): [optional] # noqa: E501 + row_version (str, none_type): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """Supplier - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + downstream_id (str, none_type): The third-party API ID of original entity. [optional] # noqa: E501 + company_name (str, none_type): [optional] # noqa: E501 + display_name (str, none_type): Display name of supplier.. [optional] # noqa: E501 + title (str, none_type): [optional] # noqa: E501 + first_name (str, none_type): [optional] # noqa: E501 + middle_name (str, none_type): [optional] # noqa: E501 + last_name (str, none_type): [optional] # noqa: E501 + suffix (str, none_type): [optional] # noqa: E501 + addresses ([Address]): [optional] # noqa: E501 + notes (str, none_type): [optional] # noqa: E501 + phone_numbers ([PhoneNumber]): [optional] # noqa: E501 + emails ([Email]): [optional] # noqa: E501 + websites ([Website]): [optional] # noqa: E501 + bank_accounts ([BankAccount]): [optional] # noqa: E501 + tax_rate (LinkedTaxRate): [optional] # noqa: E501 + tax_number (str, none_type): [optional] # noqa: E501 + currency (Currency): [optional] # noqa: E501 + account (LinkedLedgerAccount): [optional] # noqa: E501 + status (str, none_type): Customer status. [optional] # noqa: E501 + updated_by (str, none_type): [optional] # noqa: E501 + created_by (str, none_type): [optional] # noqa: E501 + updated_at (datetime): [optional] # noqa: E501 + created_at (datetime): [optional] # noqa: E501 + row_version (str, none_type): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/supported_property.py b/src/apideck/model/supported_property.py new file mode 100644 index 0000000000..70a57081f5 --- /dev/null +++ b/src/apideck/model/supported_property.py @@ -0,0 +1,265 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.supported_property_child_properties import SupportedPropertyChildProperties + globals()['SupportedPropertyChildProperties'] = SupportedPropertyChildProperties + + +class SupportedProperty(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'unified_property': (str,), # noqa: E501 + 'child_properties': ([SupportedPropertyChildProperties],), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'unified_property': 'unified_property', # noqa: E501 + 'child_properties': 'child_properties', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """SupportedProperty - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + unified_property (str): Name of the property in our Unified API.. [optional] # noqa: E501 + child_properties ([SupportedPropertyChildProperties]): List of child properties of the unified property.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """SupportedProperty - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + unified_property (str): Name of the property in our Unified API.. [optional] # noqa: E501 + child_properties ([SupportedPropertyChildProperties]): List of child properties of the unified property.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/supported_property_child_properties.py b/src/apideck/model/supported_property_child_properties.py new file mode 100644 index 0000000000..56b27af152 --- /dev/null +++ b/src/apideck/model/supported_property_child_properties.py @@ -0,0 +1,261 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.supported_property import SupportedProperty + globals()['SupportedProperty'] = SupportedProperty + + +class SupportedPropertyChildProperties(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'unified_property': (SupportedProperty,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'unified_property': 'unified_property', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """SupportedPropertyChildProperties - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + unified_property (SupportedProperty): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """SupportedPropertyChildProperties - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + unified_property (SupportedProperty): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/tags.py b/src/apideck/model/tags.py new file mode 100644 index 0000000000..a838b36fd4 --- /dev/null +++ b/src/apideck/model/tags.py @@ -0,0 +1,278 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class Tags(ModelSimple): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'value': ([str],), + } + + @cached_property + def discriminator(): + return None + + + attribute_map = {} + + read_only_vars = set() + + _composed_schemas = None + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): + """Tags - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] ([str]): # noqa: E501 + + Keyword Args: + value ([str]): # noqa: E501 + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + self.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): + """Tags - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] ([str]): # noqa: E501 + + Keyword Args: + value ([str]): # noqa: E501 + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + self.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + return self diff --git a/src/apideck/model/tax.py b/src/apideck/model/tax.py new file mode 100644 index 0000000000..5b7996ab81 --- /dev/null +++ b/src/apideck/model/tax.py @@ -0,0 +1,263 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class Tax(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'name': (str,), # noqa: E501 + 'employer': (bool,), # noqa: E501 + 'amount': (float,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'name': 'name', # noqa: E501 + 'employer': 'employer', # noqa: E501 + 'amount': 'amount', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """Tax - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + name (str): The name of the tax.. [optional] # noqa: E501 + employer (bool): Paid by employer.. [optional] # noqa: E501 + amount (float): The amount of the tax.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """Tax - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + name (str): The name of the tax.. [optional] # noqa: E501 + employer (bool): Paid by employer.. [optional] # noqa: E501 + amount (float): The amount of the tax.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/tax_rate.py b/src/apideck/model/tax_rate.py new file mode 100644 index 0000000000..8f48839e6d --- /dev/null +++ b/src/apideck/model/tax_rate.py @@ -0,0 +1,330 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class TaxRate(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('status',): { + 'None': None, + 'ACTIVE': "active", + 'INACTIVE': "inactive", + 'ARCHIVED': "archived", + }, + } + + validations = { + ('name',): { + 'min_length': 1, + }, + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'id': (str, none_type,), # noqa: E501 + 'name': (str,), # noqa: E501 + 'code': (str, none_type,), # noqa: E501 + 'description': (str, none_type,), # noqa: E501 + 'effective_tax_rate': (float, none_type,), # noqa: E501 + 'total_tax_rate': (float, none_type,), # noqa: E501 + 'tax_payable_account_id': (str, none_type,), # noqa: E501 + 'tax_remitted_account_id': (str, none_type,), # noqa: E501 + 'components': ([bool, date, datetime, dict, float, int, list, str, none_type], none_type,), # noqa: E501 + 'type': (str, none_type,), # noqa: E501 + 'report_tax_type': (str, none_type,), # noqa: E501 + 'original_tax_rate_id': (str, none_type,), # noqa: E501 + 'status': (str, none_type,), # noqa: E501 + 'row_version': (str, none_type,), # noqa: E501 + 'updated_by': (str, none_type,), # noqa: E501 + 'created_by': (str, none_type,), # noqa: E501 + 'updated_at': (datetime,), # noqa: E501 + 'created_at': (datetime,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'name': 'name', # noqa: E501 + 'code': 'code', # noqa: E501 + 'description': 'description', # noqa: E501 + 'effective_tax_rate': 'effective_tax_rate', # noqa: E501 + 'total_tax_rate': 'total_tax_rate', # noqa: E501 + 'tax_payable_account_id': 'tax_payable_account_id', # noqa: E501 + 'tax_remitted_account_id': 'tax_remitted_account_id', # noqa: E501 + 'components': 'components', # noqa: E501 + 'type': 'type', # noqa: E501 + 'report_tax_type': 'report_tax_type', # noqa: E501 + 'original_tax_rate_id': 'original_tax_rate_id', # noqa: E501 + 'status': 'status', # noqa: E501 + 'row_version': 'row_version', # noqa: E501 + 'updated_by': 'updated_by', # noqa: E501 + 'created_by': 'created_by', # noqa: E501 + 'updated_at': 'updated_at', # noqa: E501 + 'created_at': 'created_at', # noqa: E501 + } + + read_only_vars = { + 'updated_by', # noqa: E501 + 'created_by', # noqa: E501 + 'updated_at', # noqa: E501 + 'created_at', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """TaxRate - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str, none_type): ID assigned to identify this tax rate.. [optional] # noqa: E501 + name (str): Name assigned to identify this tax rate.. [optional] # noqa: E501 + code (str, none_type): Tax code assigned to identify this tax rate.. [optional] # noqa: E501 + description (str, none_type): Description of tax rate. [optional] # noqa: E501 + effective_tax_rate (float, none_type): Effective tax rate. [optional] # noqa: E501 + total_tax_rate (float, none_type): Not compounded sum of the components of a tax rate. [optional] # noqa: E501 + tax_payable_account_id (str, none_type): Unique identifier for the account for tax collected.. [optional] # noqa: E501 + tax_remitted_account_id (str, none_type): Unique identifier for the account for tax remitted.. [optional] # noqa: E501 + components ([bool, date, datetime, dict, float, int, list, str, none_type], none_type): [optional] # noqa: E501 + type (str, none_type): Tax type used to indicate the source of tax collected or paid. [optional] # noqa: E501 + report_tax_type (str, none_type): Report Tax type to aggregate tax collected or paid for reporting purposes. [optional] # noqa: E501 + original_tax_rate_id (str, none_type): ID of the original tax rate from which the new tax rate is derived. Helps to understand the relationship between corresponding tax rate entities.. [optional] # noqa: E501 + status (str, none_type): Tax rate status. [optional] # noqa: E501 + row_version (str, none_type): [optional] # noqa: E501 + updated_by (str, none_type): [optional] # noqa: E501 + created_by (str, none_type): [optional] # noqa: E501 + updated_at (datetime): [optional] # noqa: E501 + created_at (datetime): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """TaxRate - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str, none_type): ID assigned to identify this tax rate.. [optional] # noqa: E501 + name (str): Name assigned to identify this tax rate.. [optional] # noqa: E501 + code (str, none_type): Tax code assigned to identify this tax rate.. [optional] # noqa: E501 + description (str, none_type): Description of tax rate. [optional] # noqa: E501 + effective_tax_rate (float, none_type): Effective tax rate. [optional] # noqa: E501 + total_tax_rate (float, none_type): Not compounded sum of the components of a tax rate. [optional] # noqa: E501 + tax_payable_account_id (str, none_type): Unique identifier for the account for tax collected.. [optional] # noqa: E501 + tax_remitted_account_id (str, none_type): Unique identifier for the account for tax remitted.. [optional] # noqa: E501 + components ([bool, date, datetime, dict, float, int, list, str, none_type], none_type): [optional] # noqa: E501 + type (str, none_type): Tax type used to indicate the source of tax collected or paid. [optional] # noqa: E501 + report_tax_type (str, none_type): Report Tax type to aggregate tax collected or paid for reporting purposes. [optional] # noqa: E501 + original_tax_rate_id (str, none_type): ID of the original tax rate from which the new tax rate is derived. Helps to understand the relationship between corresponding tax rate entities.. [optional] # noqa: E501 + status (str, none_type): Tax rate status. [optional] # noqa: E501 + row_version (str, none_type): [optional] # noqa: E501 + updated_by (str, none_type): [optional] # noqa: E501 + created_by (str, none_type): [optional] # noqa: E501 + updated_at (datetime): [optional] # noqa: E501 + created_at (datetime): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/tax_rates_filter.py b/src/apideck/model/tax_rates_filter.py new file mode 100644 index 0000000000..f7e5422f01 --- /dev/null +++ b/src/apideck/model/tax_rates_filter.py @@ -0,0 +1,265 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class TaxRatesFilter(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'assets': (bool,), # noqa: E501 + 'equity': (bool,), # noqa: E501 + 'expenses': (bool,), # noqa: E501 + 'liabilities': (bool,), # noqa: E501 + 'revenue': (bool,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'assets': 'assets', # noqa: E501 + 'equity': 'equity', # noqa: E501 + 'expenses': 'expenses', # noqa: E501 + 'liabilities': 'liabilities', # noqa: E501 + 'revenue': 'revenue', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """TaxRatesFilter - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + assets (bool): Boolean to describe if tax rate can be used for asset accounts. [optional] # noqa: E501 + equity (bool): Boolean to describe if tax rate can be used for equity accounts. [optional] # noqa: E501 + expenses (bool): Boolean to describe if tax rate can be used for expense accounts. [optional] # noqa: E501 + liabilities (bool): Boolean to describe if tax rate can be used for liability accounts. [optional] # noqa: E501 + revenue (bool): Boolean to describe if tax rate can be used for revenue accounts. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """TaxRatesFilter - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + assets (bool): Boolean to describe if tax rate can be used for asset accounts. [optional] # noqa: E501 + equity (bool): Boolean to describe if tax rate can be used for equity accounts. [optional] # noqa: E501 + expenses (bool): Boolean to describe if tax rate can be used for expense accounts. [optional] # noqa: E501 + liabilities (bool): Boolean to describe if tax rate can be used for liability accounts. [optional] # noqa: E501 + revenue (bool): Boolean to describe if tax rate can be used for revenue accounts. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/tender.py b/src/apideck/model/tender.py new file mode 100644 index 0000000000..3add2d1cec --- /dev/null +++ b/src/apideck/model/tender.py @@ -0,0 +1,298 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class Tender(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'id': (str,), # noqa: E501 + 'key': (str, none_type,), # noqa: E501 + 'label': (str, none_type,), # noqa: E501 + 'active': (bool, none_type,), # noqa: E501 + 'hidden': (bool, none_type,), # noqa: E501 + 'editable': (bool, none_type,), # noqa: E501 + 'opens_cash_drawer': (bool,), # noqa: E501 + 'allows_tipping': (bool,), # noqa: E501 + 'updated_by': (str, none_type,), # noqa: E501 + 'created_by': (str, none_type,), # noqa: E501 + 'updated_at': (datetime,), # noqa: E501 + 'created_at': (datetime,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'key': 'key', # noqa: E501 + 'label': 'label', # noqa: E501 + 'active': 'active', # noqa: E501 + 'hidden': 'hidden', # noqa: E501 + 'editable': 'editable', # noqa: E501 + 'opens_cash_drawer': 'opens_cash_drawer', # noqa: E501 + 'allows_tipping': 'allows_tipping', # noqa: E501 + 'updated_by': 'updated_by', # noqa: E501 + 'created_by': 'created_by', # noqa: E501 + 'updated_at': 'updated_at', # noqa: E501 + 'created_at': 'created_at', # noqa: E501 + } + + read_only_vars = { + 'id', # noqa: E501 + 'updated_by', # noqa: E501 + 'created_by', # noqa: E501 + 'updated_at', # noqa: E501 + 'created_at', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """Tender - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + key (str, none_type): [optional] # noqa: E501 + label (str, none_type): [optional] # noqa: E501 + active (bool, none_type): [optional] # noqa: E501 + hidden (bool, none_type): [optional] # noqa: E501 + editable (bool, none_type): [optional] # noqa: E501 + opens_cash_drawer (bool): If this tender opens the cash drawer. [optional] if omitted the server will use the default value of True # noqa: E501 + allows_tipping (bool): Allow tipping on payment from tender. [optional] if omitted the server will use the default value of True # noqa: E501 + updated_by (str, none_type): [optional] # noqa: E501 + created_by (str, none_type): [optional] # noqa: E501 + updated_at (datetime): [optional] # noqa: E501 + created_at (datetime): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """Tender - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + key (str, none_type): [optional] # noqa: E501 + label (str, none_type): [optional] # noqa: E501 + active (bool, none_type): [optional] # noqa: E501 + hidden (bool, none_type): [optional] # noqa: E501 + editable (bool, none_type): [optional] # noqa: E501 + opens_cash_drawer (bool): If this tender opens the cash drawer. [optional] if omitted the server will use the default value of True # noqa: E501 + allows_tipping (bool): Allow tipping on payment from tender. [optional] if omitted the server will use the default value of True # noqa: E501 + updated_by (str, none_type): [optional] # noqa: E501 + created_by (str, none_type): [optional] # noqa: E501 + updated_at (datetime): [optional] # noqa: E501 + created_at (datetime): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/time_off_request.py b/src/apideck/model/time_off_request.py new file mode 100644 index 0000000000..9a4596eb95 --- /dev/null +++ b/src/apideck/model/time_off_request.py @@ -0,0 +1,365 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.time_off_request_notes import TimeOffRequestNotes + globals()['TimeOffRequestNotes'] = TimeOffRequestNotes + + +class TimeOffRequest(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('status',): { + 'REQUESTED': "requested", + 'APPROVED': "approved", + 'DECLINED': "declined", + 'CANCELLED': "cancelled", + 'DELETED': "deleted", + 'OTHER': "other", + }, + ('request_type',): { + 'VACATION': "vacation", + 'SICK': "sick", + 'PERSONAL': "personal", + 'JURY_DUTY': "jury_duty", + 'VOLUNTEER': "volunteer", + 'BEREAVEMENT': "bereavement", + 'OTHER': "other", + }, + ('units',): { + 'DAYS': "days", + 'HOURS': "hours", + 'OTHER': "other", + }, + } + + validations = { + ('start_date',): { + 'regex': { + 'pattern': r'^\d{4}-\d{2}-\d{2}$', # noqa: E501 + }, + }, + ('end_date',): { + 'regex': { + 'pattern': r'^\d{4}-\d{2}-\d{2}$', # noqa: E501 + }, + }, + ('request_date',): { + 'regex': { + 'pattern': r'^\d{4}-\d{2}-\d{2}$', # noqa: E501 + }, + }, + ('approval_date',): { + 'regex': { + 'pattern': r'^\d{4}-\d{2}-\d{2}$', # noqa: E501 + }, + }, + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'id': (str,), # noqa: E501 + 'employee_id': (str,), # noqa: E501 + 'policy_id': (str,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'description': (str,), # noqa: E501 + 'start_date': (str,), # noqa: E501 + 'end_date': (str,), # noqa: E501 + 'request_date': (str,), # noqa: E501 + 'request_type': (str,), # noqa: E501 + 'approval_date': (str,), # noqa: E501 + 'units': (str,), # noqa: E501 + 'amount': (float,), # noqa: E501 + 'notes': (TimeOffRequestNotes,), # noqa: E501 + 'updated_by': (str, none_type,), # noqa: E501 + 'created_by': (str, none_type,), # noqa: E501 + 'updated_at': (datetime,), # noqa: E501 + 'created_at': (datetime,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'employee_id': 'employee_id', # noqa: E501 + 'policy_id': 'policy_id', # noqa: E501 + 'status': 'status', # noqa: E501 + 'description': 'description', # noqa: E501 + 'start_date': 'start_date', # noqa: E501 + 'end_date': 'end_date', # noqa: E501 + 'request_date': 'request_date', # noqa: E501 + 'request_type': 'request_type', # noqa: E501 + 'approval_date': 'approval_date', # noqa: E501 + 'units': 'units', # noqa: E501 + 'amount': 'amount', # noqa: E501 + 'notes': 'notes', # noqa: E501 + 'updated_by': 'updated_by', # noqa: E501 + 'created_by': 'created_by', # noqa: E501 + 'updated_at': 'updated_at', # noqa: E501 + 'created_at': 'created_at', # noqa: E501 + } + + read_only_vars = { + 'id', # noqa: E501 + 'updated_by', # noqa: E501 + 'created_by', # noqa: E501 + 'updated_at', # noqa: E501 + 'created_at', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """TimeOffRequest - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + employee_id (str): ID of the employee. [optional] # noqa: E501 + policy_id (str): ID of the policy. [optional] # noqa: E501 + status (str): The status of the time off request.. [optional] # noqa: E501 + description (str): Description of the time off request.. [optional] # noqa: E501 + start_date (str): The start date of the time off request.. [optional] # noqa: E501 + end_date (str): The end date of the time off request.. [optional] # noqa: E501 + request_date (str): The date the request was made.. [optional] # noqa: E501 + request_type (str): The type of request. [optional] # noqa: E501 + approval_date (str): The date the request was approved. [optional] # noqa: E501 + units (str): The unit of time off requested. Possible values include: `hours`, `days`, or `other`.. [optional] # noqa: E501 + amount (float): The amount of time off requested.. [optional] # noqa: E501 + notes (TimeOffRequestNotes): [optional] # noqa: E501 + updated_by (str, none_type): [optional] # noqa: E501 + created_by (str, none_type): [optional] # noqa: E501 + updated_at (datetime): [optional] # noqa: E501 + created_at (datetime): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """TimeOffRequest - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + employee_id (str): ID of the employee. [optional] # noqa: E501 + policy_id (str): ID of the policy. [optional] # noqa: E501 + status (str): The status of the time off request.. [optional] # noqa: E501 + description (str): Description of the time off request.. [optional] # noqa: E501 + start_date (str): The start date of the time off request.. [optional] # noqa: E501 + end_date (str): The end date of the time off request.. [optional] # noqa: E501 + request_date (str): The date the request was made.. [optional] # noqa: E501 + request_type (str): The type of request. [optional] # noqa: E501 + approval_date (str): The date the request was approved. [optional] # noqa: E501 + units (str): The unit of time off requested. Possible values include: `hours`, `days`, or `other`.. [optional] # noqa: E501 + amount (float): The amount of time off requested.. [optional] # noqa: E501 + notes (TimeOffRequestNotes): [optional] # noqa: E501 + updated_by (str, none_type): [optional] # noqa: E501 + created_by (str, none_type): [optional] # noqa: E501 + updated_at (datetime): [optional] # noqa: E501 + created_at (datetime): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/time_off_request_notes.py b/src/apideck/model/time_off_request_notes.py new file mode 100644 index 0000000000..7870976462 --- /dev/null +++ b/src/apideck/model/time_off_request_notes.py @@ -0,0 +1,259 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class TimeOffRequestNotes(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'employee': (str,), # noqa: E501 + 'manager': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'employee': 'employee', # noqa: E501 + 'manager': 'manager', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """TimeOffRequestNotes - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + employee (str): [optional] # noqa: E501 + manager (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """TimeOffRequestNotes - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + employee (str): [optional] # noqa: E501 + manager (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/time_off_requests_filter.py b/src/apideck/model/time_off_requests_filter.py new file mode 100644 index 0000000000..991131d5e3 --- /dev/null +++ b/src/apideck/model/time_off_requests_filter.py @@ -0,0 +1,279 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class TimeOffRequestsFilter(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('time_off_request_status',): { + 'REQUESTED': "requested", + 'APPROVED': "approved", + 'DECLINED': "declined", + 'CANCELLED': "cancelled", + 'DELETED': "deleted", + 'OTHER': "other", + }, + } + + validations = { + ('start_date',): { + 'regex': { + 'pattern': r'^\d{4}-\d{2}-\d{2}$', # noqa: E501 + }, + }, + ('end_date',): { + 'regex': { + 'pattern': r'^\d{4}-\d{2}-\d{2}$', # noqa: E501 + }, + }, + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'start_date': (str,), # noqa: E501 + 'end_date': (str,), # noqa: E501 + 'employee_id': (str,), # noqa: E501 + 'time_off_request_status': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'start_date': 'start_date', # noqa: E501 + 'end_date': 'end_date', # noqa: E501 + 'employee_id': 'employee_id', # noqa: E501 + 'time_off_request_status': 'time_off_request_status', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """TimeOffRequestsFilter - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + start_date (str): Start date. [optional] # noqa: E501 + end_date (str): End date. [optional] # noqa: E501 + employee_id (str): Employee ID. [optional] # noqa: E501 + time_off_request_status (str): Time off request status to filter on. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """TimeOffRequestsFilter - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + start_date (str): Start date. [optional] # noqa: E501 + end_date (str): End date. [optional] # noqa: E501 + employee_id (str): Employee ID. [optional] # noqa: E501 + time_off_request_status (str): Time off request status to filter on. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/too_many_requests_response.py b/src/apideck/model/too_many_requests_response.py new file mode 100644 index 0000000000..1c3f8c21f0 --- /dev/null +++ b/src/apideck/model/too_many_requests_response.py @@ -0,0 +1,281 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.too_many_requests_response_detail import TooManyRequestsResponseDetail + globals()['TooManyRequestsResponseDetail'] = TooManyRequestsResponseDetail + + +class TooManyRequestsResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (float,), # noqa: E501 + 'error': (str,), # noqa: E501 + 'type_name': (str,), # noqa: E501 + 'message': (str,), # noqa: E501 + 'detail': (TooManyRequestsResponseDetail,), # noqa: E501 + 'ref': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'error': 'error', # noqa: E501 + 'type_name': 'type_name', # noqa: E501 + 'message': 'message', # noqa: E501 + 'detail': 'detail', # noqa: E501 + 'ref': 'ref', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """TooManyRequestsResponse - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + status_code (float): HTTP status code. [optional] # noqa: E501 + error (str): Contains an explanation of the status_code as defined in HTTP/1.1 standard (RFC 6585). [optional] # noqa: E501 + type_name (str): The type of error returned. [optional] # noqa: E501 + message (str): A human-readable message providing more details about the error.. [optional] # noqa: E501 + detail (TooManyRequestsResponseDetail): [optional] # noqa: E501 + ref (str): Link to documentation of error type. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """TooManyRequestsResponse - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + status_code (float): HTTP status code. [optional] # noqa: E501 + error (str): Contains an explanation of the status_code as defined in HTTP/1.1 standard (RFC 6585). [optional] # noqa: E501 + type_name (str): The type of error returned. [optional] # noqa: E501 + message (str): A human-readable message providing more details about the error.. [optional] # noqa: E501 + detail (TooManyRequestsResponseDetail): [optional] # noqa: E501 + ref (str): Link to documentation of error type. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/too_many_requests_response_detail.py b/src/apideck/model/too_many_requests_response_detail.py new file mode 100644 index 0000000000..7d01d007c1 --- /dev/null +++ b/src/apideck/model/too_many_requests_response_detail.py @@ -0,0 +1,259 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class TooManyRequestsResponseDetail(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'context': (str,), # noqa: E501 + 'error': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'context': 'context', # noqa: E501 + 'error': 'error', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """TooManyRequestsResponseDetail - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + context (str): [optional] # noqa: E501 + error ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """TooManyRequestsResponseDetail - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + context (str): [optional] # noqa: E501 + error ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/unauthorized_response.py b/src/apideck/model/unauthorized_response.py new file mode 100644 index 0000000000..e03111ff92 --- /dev/null +++ b/src/apideck/model/unauthorized_response.py @@ -0,0 +1,275 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class UnauthorizedResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'status_code': (float,), # noqa: E501 + 'error': (str,), # noqa: E501 + 'type_name': (str,), # noqa: E501 + 'message': (str,), # noqa: E501 + 'detail': (str,), # noqa: E501 + 'ref': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'error': 'error', # noqa: E501 + 'type_name': 'type_name', # noqa: E501 + 'message': 'message', # noqa: E501 + 'detail': 'detail', # noqa: E501 + 'ref': 'ref', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """UnauthorizedResponse - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + status_code (float): HTTP status code. [optional] # noqa: E501 + error (str): Contains an explanation of the status_code as defined in HTTP/1.1 standard (RFC 7231). [optional] # noqa: E501 + type_name (str): The type of error returned. [optional] # noqa: E501 + message (str): A human-readable message providing more details about the error.. [optional] # noqa: E501 + detail (str): Contains parameter or domain specific information related to the error and why it occurred.. [optional] # noqa: E501 + ref (str): Link to documentation of error type. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """UnauthorizedResponse - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + status_code (float): HTTP status code. [optional] # noqa: E501 + error (str): Contains an explanation of the status_code as defined in HTTP/1.1 standard (RFC 7231). [optional] # noqa: E501 + type_name (str): The type of error returned. [optional] # noqa: E501 + message (str): A human-readable message providing more details about the error.. [optional] # noqa: E501 + detail (str): Contains parameter or domain specific information related to the error and why it occurred.. [optional] # noqa: E501 + ref (str): Link to documentation of error type. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/unexpected_error_response.py b/src/apideck/model/unexpected_error_response.py new file mode 100644 index 0000000000..0f179b9069 --- /dev/null +++ b/src/apideck/model/unexpected_error_response.py @@ -0,0 +1,275 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class UnexpectedErrorResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'status_code': (float,), # noqa: E501 + 'error': (str,), # noqa: E501 + 'type_name': (str,), # noqa: E501 + 'message': (str,), # noqa: E501 + 'detail': (bool, date, datetime, dict, float, int, list, str, none_type,), # noqa: E501 + 'ref': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'error': 'error', # noqa: E501 + 'type_name': 'type_name', # noqa: E501 + 'message': 'message', # noqa: E501 + 'detail': 'detail', # noqa: E501 + 'ref': 'ref', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """UnexpectedErrorResponse - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + status_code (float): HTTP status code. [optional] # noqa: E501 + error (str): Contains an explanation of the status_code as defined in HTTP/1.1 standard (RFC 7231). [optional] # noqa: E501 + type_name (str): The type of error returned. [optional] # noqa: E501 + message (str): A human-readable message providing more details about the error.. [optional] # noqa: E501 + detail (bool, date, datetime, dict, float, int, list, str, none_type): Contains parameter or domain specific information related to the error and why it occurred.. [optional] # noqa: E501 + ref (str): Link to documentation of error type. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """UnexpectedErrorResponse - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + status_code (float): HTTP status code. [optional] # noqa: E501 + error (str): Contains an explanation of the status_code as defined in HTTP/1.1 standard (RFC 7231). [optional] # noqa: E501 + type_name (str): The type of error returned. [optional] # noqa: E501 + message (str): A human-readable message providing more details about the error.. [optional] # noqa: E501 + detail (bool, date, datetime, dict, float, int, list, str, none_type): Contains parameter or domain specific information related to the error and why it occurred.. [optional] # noqa: E501 + ref (str): Link to documentation of error type. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/unified_api_id.py b/src/apideck/model/unified_api_id.py new file mode 100644 index 0000000000..8a1af0ec9b --- /dev/null +++ b/src/apideck/model/unified_api_id.py @@ -0,0 +1,305 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class UnifiedApiId(ModelSimple): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('value',): { + 'VAULT': "vault", + 'LEAD': "lead", + 'CRM': "crm", + 'ACCOUNTING': "accounting", + 'FILE-STORAGE': "file-storage", + 'SPREADSHEET': "spreadsheet", + 'EMAIL': "email", + 'SCRIPT': "script", + 'SMS': "sms", + 'TEAM-MESSAGING': "team-messaging", + 'ECOMMERCE': "ecommerce", + 'PAYROLL': "payroll", + 'CUSTOMER-SUPPORT': "customer-support", + 'TIME-REGISTRATION': "time-registration", + 'TRANSACTIONAL-EMAIL': "transactional-email", + 'FORM': "form", + 'CSP': "csp", + 'EMAIL-MARKETING': "email-marketing", + 'ATS': "ats", + 'HRIS': "hris", + 'POS': "pos", + 'PROJECT-MANAGEMENT': "project-management", + 'EXPENSE-MANAGEMENT': "expense-management", + 'CALENDAR': "calendar", + 'PROCUREMENT': "procurement", + }, + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'value': (str,), + } + + @cached_property + def discriminator(): + return None + + + attribute_map = {} + + read_only_vars = set() + + _composed_schemas = None + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): + """UnifiedApiId - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] (str): Name of Apideck Unified API., must be one of ["vault", "lead", "crm", "accounting", "file-storage", "spreadsheet", "email", "script", "sms", "team-messaging", "ecommerce", "payroll", "customer-support", "time-registration", "transactional-email", "form", "csp", "email-marketing", "ats", "hris", "pos", "project-management", "expense-management", "calendar", "procurement", ] # noqa: E501 + + Keyword Args: + value (str): Name of Apideck Unified API., must be one of ["vault", "lead", "crm", "accounting", "file-storage", "spreadsheet", "email", "script", "sms", "team-messaging", "ecommerce", "payroll", "customer-support", "time-registration", "transactional-email", "form", "csp", "email-marketing", "ats", "hris", "pos", "project-management", "expense-management", "calendar", "procurement", ] # noqa: E501 + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + self.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): + """UnifiedApiId - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] (str): Name of Apideck Unified API., must be one of ["vault", "lead", "crm", "accounting", "file-storage", "spreadsheet", "email", "script", "sms", "team-messaging", "ecommerce", "payroll", "customer-support", "time-registration", "transactional-email", "form", "csp", "email-marketing", "ats", "hris", "pos", "project-management", "expense-management", "calendar", "procurement", ] # noqa: E501 + + Keyword Args: + value (str): Name of Apideck Unified API., must be one of ["vault", "lead", "crm", "accounting", "file-storage", "spreadsheet", "email", "script", "sms", "team-messaging", "ecommerce", "payroll", "customer-support", "time-registration", "transactional-email", "form", "csp", "email-marketing", "ats", "hris", "pos", "project-management", "expense-management", "calendar", "procurement", ] # noqa: E501 + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + self.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + return self diff --git a/src/apideck/model/unified_file.py b/src/apideck/model/unified_file.py new file mode 100644 index 0000000000..d1d3dc0279 --- /dev/null +++ b/src/apideck/model/unified_file.py @@ -0,0 +1,331 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.file_type import FileType + from apideck.model.linked_folder import LinkedFolder + from apideck.model.owner import Owner + globals()['FileType'] = FileType + globals()['LinkedFolder'] = LinkedFolder + globals()['Owner'] = Owner + + +class UnifiedFile(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'id': (str,), # noqa: E501 + 'name': (str,), # noqa: E501 + 'type': (FileType,), # noqa: E501 + 'downstream_id': (str, none_type,), # noqa: E501 + 'description': (str,), # noqa: E501 + 'path': (str,), # noqa: E501 + 'mime_type': (str,), # noqa: E501 + 'downloadable': (bool,), # noqa: E501 + 'size': (int,), # noqa: E501 + 'owner': (Owner,), # noqa: E501 + 'parent_folders': ([LinkedFolder],), # noqa: E501 + 'parent_folders_complete': (bool,), # noqa: E501 + 'updated_by': (str, none_type,), # noqa: E501 + 'created_by': (str, none_type,), # noqa: E501 + 'updated_at': (datetime,), # noqa: E501 + 'created_at': (datetime,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'name': 'name', # noqa: E501 + 'type': 'type', # noqa: E501 + 'downstream_id': 'downstream_id', # noqa: E501 + 'description': 'description', # noqa: E501 + 'path': 'path', # noqa: E501 + 'mime_type': 'mime_type', # noqa: E501 + 'downloadable': 'downloadable', # noqa: E501 + 'size': 'size', # noqa: E501 + 'owner': 'owner', # noqa: E501 + 'parent_folders': 'parent_folders', # noqa: E501 + 'parent_folders_complete': 'parent_folders_complete', # noqa: E501 + 'updated_by': 'updated_by', # noqa: E501 + 'created_by': 'created_by', # noqa: E501 + 'updated_at': 'updated_at', # noqa: E501 + 'created_at': 'created_at', # noqa: E501 + } + + read_only_vars = { + 'id', # noqa: E501 + 'downstream_id', # noqa: E501 + 'updated_by', # noqa: E501 + 'created_by', # noqa: E501 + 'updated_at', # noqa: E501 + 'created_at', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, id, name, type, *args, **kwargs): # noqa: E501 + """UnifiedFile - a model defined in OpenAPI + + Args: + id (str): + name (str): The name of the file + type (FileType): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + downstream_id (str, none_type): The third-party API ID of original entity. [optional] # noqa: E501 + description (str): Optional description of the file. [optional] # noqa: E501 + path (str): The full path of the file or folder (includes the file name). [optional] # noqa: E501 + mime_type (str): The MIME type of the file.. [optional] # noqa: E501 + downloadable (bool): Whether the current user can download this file. [optional] # noqa: E501 + size (int): The size of the file in bytes. [optional] # noqa: E501 + owner (Owner): [optional] # noqa: E501 + parent_folders ([LinkedFolder]): The parent folders of the file, starting from the root. [optional] # noqa: E501 + parent_folders_complete (bool): Whether the list of parent folder is complete. Some connectors only return the direct parent of a file. [optional] # noqa: E501 + updated_by (str, none_type): [optional] # noqa: E501 + created_by (str, none_type): [optional] # noqa: E501 + updated_at (datetime): [optional] # noqa: E501 + created_at (datetime): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.id = id + self.name = name + self.type = type + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, name, type, *args, **kwargs): # noqa: E501 + """UnifiedFile - a model defined in OpenAPI + + name (str): The name of the file + type (FileType): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + downstream_id (str, none_type): The third-party API ID of original entity. [optional] # noqa: E501 + description (str): Optional description of the file. [optional] # noqa: E501 + path (str): The full path of the file or folder (includes the file name). [optional] # noqa: E501 + mime_type (str): The MIME type of the file.. [optional] # noqa: E501 + downloadable (bool): Whether the current user can download this file. [optional] # noqa: E501 + size (int): The size of the file in bytes. [optional] # noqa: E501 + owner (Owner): [optional] # noqa: E501 + parent_folders ([LinkedFolder]): The parent folders of the file, starting from the root. [optional] # noqa: E501 + parent_folders_complete (bool): Whether the list of parent folder is complete. Some connectors only return the direct parent of a file. [optional] # noqa: E501 + updated_by (str, none_type): [optional] # noqa: E501 + created_by (str, none_type): [optional] # noqa: E501 + updated_at (datetime): [optional] # noqa: E501 + created_at (datetime): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.name = name + self.type = type + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/unified_id.py b/src/apideck/model/unified_id.py new file mode 100644 index 0000000000..69cddecfd4 --- /dev/null +++ b/src/apideck/model/unified_id.py @@ -0,0 +1,258 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class UnifiedId(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'id': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + } + + read_only_vars = { + 'id', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 + """UnifiedId - a model defined in OpenAPI + + Args: + id (str): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.id = id + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """UnifiedId - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/unprocessable_response.py b/src/apideck/model/unprocessable_response.py new file mode 100644 index 0000000000..1ba3ec5786 --- /dev/null +++ b/src/apideck/model/unprocessable_response.py @@ -0,0 +1,275 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class UnprocessableResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'status_code': (float,), # noqa: E501 + 'error': (str,), # noqa: E501 + 'type_name': (str,), # noqa: E501 + 'message': (str,), # noqa: E501 + 'detail': (str,), # noqa: E501 + 'ref': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'error': 'error', # noqa: E501 + 'type_name': 'type_name', # noqa: E501 + 'message': 'message', # noqa: E501 + 'detail': 'detail', # noqa: E501 + 'ref': 'ref', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """UnprocessableResponse - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + status_code (float): HTTP status code. [optional] # noqa: E501 + error (str): Contains an explanation of the status_code as defined in HTTP/1.1 standard (RFC 7231). [optional] # noqa: E501 + type_name (str): The type of error returned. [optional] # noqa: E501 + message (str): A human-readable message providing more details about the error.. [optional] # noqa: E501 + detail (str): Contains parameter or domain specific information related to the error and why it occurred.. [optional] # noqa: E501 + ref (str): Link to documentation of error type. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """UnprocessableResponse - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + status_code (float): HTTP status code. [optional] # noqa: E501 + error (str): Contains an explanation of the status_code as defined in HTTP/1.1 standard (RFC 7231). [optional] # noqa: E501 + type_name (str): The type of error returned. [optional] # noqa: E501 + message (str): A human-readable message providing more details about the error.. [optional] # noqa: E501 + detail (str): Contains parameter or domain specific information related to the error and why it occurred.. [optional] # noqa: E501 + ref (str): Link to documentation of error type. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/update_activity_response.py b/src/apideck/model/update_activity_response.py new file mode 100644 index 0000000000..5c5745d36a --- /dev/null +++ b/src/apideck/model/update_activity_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_id import UnifiedId + globals()['UnifiedId'] = UnifiedId + + +class UpdateActivityResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """UpdateActivityResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """UpdateActivityResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/update_bill_response.py b/src/apideck/model/update_bill_response.py new file mode 100644 index 0000000000..870ff9a7ce --- /dev/null +++ b/src/apideck/model/update_bill_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_id import UnifiedId + globals()['UnifiedId'] = UnifiedId + + +class UpdateBillResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """UpdateBillResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """UpdateBillResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/update_company_response.py b/src/apideck/model/update_company_response.py new file mode 100644 index 0000000000..37e85667c1 --- /dev/null +++ b/src/apideck/model/update_company_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_id import UnifiedId + globals()['UnifiedId'] = UnifiedId + + +class UpdateCompanyResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """UpdateCompanyResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """UpdateCompanyResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/update_connection_response.py b/src/apideck/model/update_connection_response.py new file mode 100644 index 0000000000..c6fa7f2af1 --- /dev/null +++ b/src/apideck/model/update_connection_response.py @@ -0,0 +1,279 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.connection import Connection + globals()['Connection'] = Connection + + +class UpdateConnectionResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'data': (Connection,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, data, *args, **kwargs): # noqa: E501 + """UpdateConnectionResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + data (Connection): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, data, *args, **kwargs): # noqa: E501 + """UpdateConnectionResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + data (Connection): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/update_contact_response.py b/src/apideck/model/update_contact_response.py new file mode 100644 index 0000000000..0f7b55fefd --- /dev/null +++ b/src/apideck/model/update_contact_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_id import UnifiedId + globals()['UnifiedId'] = UnifiedId + + +class UpdateContactResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """UpdateContactResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """UpdateContactResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/update_credit_note_response.py b/src/apideck/model/update_credit_note_response.py new file mode 100644 index 0000000000..5a9d4a1905 --- /dev/null +++ b/src/apideck/model/update_credit_note_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_id import UnifiedId + globals()['UnifiedId'] = UnifiedId + + +class UpdateCreditNoteResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """UpdateCreditNoteResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """UpdateCreditNoteResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/update_customer_response.py b/src/apideck/model/update_customer_response.py new file mode 100644 index 0000000000..9188f62660 --- /dev/null +++ b/src/apideck/model/update_customer_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_id import UnifiedId + globals()['UnifiedId'] = UnifiedId + + +class UpdateCustomerResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """UpdateCustomerResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """UpdateCustomerResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/update_customer_support_customer_response.py b/src/apideck/model/update_customer_support_customer_response.py new file mode 100644 index 0000000000..7dd0e5fe63 --- /dev/null +++ b/src/apideck/model/update_customer_support_customer_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_id import UnifiedId + globals()['UnifiedId'] = UnifiedId + + +class UpdateCustomerSupportCustomerResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """UpdateCustomerSupportCustomerResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """UpdateCustomerSupportCustomerResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/update_department_response.py b/src/apideck/model/update_department_response.py new file mode 100644 index 0000000000..385ad9d862 --- /dev/null +++ b/src/apideck/model/update_department_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_id import UnifiedId + globals()['UnifiedId'] = UnifiedId + + +class UpdateDepartmentResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """UpdateDepartmentResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """UpdateDepartmentResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/update_drive_group_response.py b/src/apideck/model/update_drive_group_response.py new file mode 100644 index 0000000000..4296f4a15c --- /dev/null +++ b/src/apideck/model/update_drive_group_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_id import UnifiedId + globals()['UnifiedId'] = UnifiedId + + +class UpdateDriveGroupResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """UpdateDriveGroupResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """UpdateDriveGroupResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/update_drive_response.py b/src/apideck/model/update_drive_response.py new file mode 100644 index 0000000000..a86fd6c7e5 --- /dev/null +++ b/src/apideck/model/update_drive_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_id import UnifiedId + globals()['UnifiedId'] = UnifiedId + + +class UpdateDriveResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """UpdateDriveResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """UpdateDriveResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/update_employee_response.py b/src/apideck/model/update_employee_response.py new file mode 100644 index 0000000000..283051b517 --- /dev/null +++ b/src/apideck/model/update_employee_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_id import UnifiedId + globals()['UnifiedId'] = UnifiedId + + +class UpdateEmployeeResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """UpdateEmployeeResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """UpdateEmployeeResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/update_file_response.py b/src/apideck/model/update_file_response.py new file mode 100644 index 0000000000..dbe7cea5dd --- /dev/null +++ b/src/apideck/model/update_file_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_id import UnifiedId + globals()['UnifiedId'] = UnifiedId + + +class UpdateFileResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """UpdateFileResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """UpdateFileResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/update_folder_request.py b/src/apideck/model/update_folder_request.py new file mode 100644 index 0000000000..d1e02fe412 --- /dev/null +++ b/src/apideck/model/update_folder_request.py @@ -0,0 +1,262 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class UpdateFolderRequest(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'id': (str,), # noqa: E501 + 'name': (str,), # noqa: E501 + 'description': (str,), # noqa: E501 + 'parent_folder_id': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'name': 'name', # noqa: E501 + 'description': 'description', # noqa: E501 + 'parent_folder_id': 'parent_folder_id', # noqa: E501 + } + + read_only_vars = { + 'id', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """UpdateFolderRequest - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + name (str): The name of the folder.. [optional] # noqa: E501 + description (str): Optional description of the folder.. [optional] # noqa: E501 + parent_folder_id (str): The parent folder to create the new file within.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """UpdateFolderRequest - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + name (str): The name of the folder.. [optional] # noqa: E501 + description (str): Optional description of the folder.. [optional] # noqa: E501 + parent_folder_id (str): The parent folder to create the new file within.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/update_folder_response.py b/src/apideck/model/update_folder_response.py new file mode 100644 index 0000000000..ba6ebf2a2d --- /dev/null +++ b/src/apideck/model/update_folder_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_id import UnifiedId + globals()['UnifiedId'] = UnifiedId + + +class UpdateFolderResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """UpdateFolderResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """UpdateFolderResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/update_hris_company_response.py b/src/apideck/model/update_hris_company_response.py new file mode 100644 index 0000000000..33f1785729 --- /dev/null +++ b/src/apideck/model/update_hris_company_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_id import UnifiedId + globals()['UnifiedId'] = UnifiedId + + +class UpdateHrisCompanyResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """UpdateHrisCompanyResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """UpdateHrisCompanyResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/update_invoice_items_response.py b/src/apideck/model/update_invoice_items_response.py new file mode 100644 index 0000000000..3760890f67 --- /dev/null +++ b/src/apideck/model/update_invoice_items_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_id import UnifiedId + globals()['UnifiedId'] = UnifiedId + + +class UpdateInvoiceItemsResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """UpdateInvoiceItemsResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """UpdateInvoiceItemsResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/update_invoice_response.py b/src/apideck/model/update_invoice_response.py new file mode 100644 index 0000000000..23de6c74a1 --- /dev/null +++ b/src/apideck/model/update_invoice_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.invoice_response import InvoiceResponse + globals()['InvoiceResponse'] = InvoiceResponse + + +class UpdateInvoiceResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (InvoiceResponse,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """UpdateInvoiceResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (InvoiceResponse): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """UpdateInvoiceResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (InvoiceResponse): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/update_item_response.py b/src/apideck/model/update_item_response.py new file mode 100644 index 0000000000..4f211d3785 --- /dev/null +++ b/src/apideck/model/update_item_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_id import UnifiedId + globals()['UnifiedId'] = UnifiedId + + +class UpdateItemResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """UpdateItemResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """UpdateItemResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/update_job_response.py b/src/apideck/model/update_job_response.py new file mode 100644 index 0000000000..5800db0aec --- /dev/null +++ b/src/apideck/model/update_job_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_id import UnifiedId + globals()['UnifiedId'] = UnifiedId + + +class UpdateJobResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """UpdateJobResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """UpdateJobResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/update_lead_response.py b/src/apideck/model/update_lead_response.py new file mode 100644 index 0000000000..1ab35184b6 --- /dev/null +++ b/src/apideck/model/update_lead_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_id import UnifiedId + globals()['UnifiedId'] = UnifiedId + + +class UpdateLeadResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """UpdateLeadResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """UpdateLeadResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/update_ledger_account_response.py b/src/apideck/model/update_ledger_account_response.py new file mode 100644 index 0000000000..ec4d6326eb --- /dev/null +++ b/src/apideck/model/update_ledger_account_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_id import UnifiedId + globals()['UnifiedId'] = UnifiedId + + +class UpdateLedgerAccountResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """UpdateLedgerAccountResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """UpdateLedgerAccountResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/update_location_response.py b/src/apideck/model/update_location_response.py new file mode 100644 index 0000000000..014a6da3a7 --- /dev/null +++ b/src/apideck/model/update_location_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_id import UnifiedId + globals()['UnifiedId'] = UnifiedId + + +class UpdateLocationResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """UpdateLocationResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """UpdateLocationResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/update_merchant_response.py b/src/apideck/model/update_merchant_response.py new file mode 100644 index 0000000000..34ef523d8c --- /dev/null +++ b/src/apideck/model/update_merchant_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_id import UnifiedId + globals()['UnifiedId'] = UnifiedId + + +class UpdateMerchantResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """UpdateMerchantResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """UpdateMerchantResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/update_message_response.py b/src/apideck/model/update_message_response.py new file mode 100644 index 0000000000..eb0ceeea29 --- /dev/null +++ b/src/apideck/model/update_message_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_id import UnifiedId + globals()['UnifiedId'] = UnifiedId + + +class UpdateMessageResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """UpdateMessageResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """UpdateMessageResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/update_modifier_group_response.py b/src/apideck/model/update_modifier_group_response.py new file mode 100644 index 0000000000..0b3beeeadd --- /dev/null +++ b/src/apideck/model/update_modifier_group_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_id import UnifiedId + globals()['UnifiedId'] = UnifiedId + + +class UpdateModifierGroupResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """UpdateModifierGroupResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """UpdateModifierGroupResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/update_modifier_response.py b/src/apideck/model/update_modifier_response.py new file mode 100644 index 0000000000..3e35c5167c --- /dev/null +++ b/src/apideck/model/update_modifier_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_id import UnifiedId + globals()['UnifiedId'] = UnifiedId + + +class UpdateModifierResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """UpdateModifierResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """UpdateModifierResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/update_note_response.py b/src/apideck/model/update_note_response.py new file mode 100644 index 0000000000..c67707e1d1 --- /dev/null +++ b/src/apideck/model/update_note_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_id import UnifiedId + globals()['UnifiedId'] = UnifiedId + + +class UpdateNoteResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """UpdateNoteResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """UpdateNoteResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/update_opportunity_response.py b/src/apideck/model/update_opportunity_response.py new file mode 100644 index 0000000000..02d24623e8 --- /dev/null +++ b/src/apideck/model/update_opportunity_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_id import UnifiedId + globals()['UnifiedId'] = UnifiedId + + +class UpdateOpportunityResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """UpdateOpportunityResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """UpdateOpportunityResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/update_order_response.py b/src/apideck/model/update_order_response.py new file mode 100644 index 0000000000..09280764d9 --- /dev/null +++ b/src/apideck/model/update_order_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_id import UnifiedId + globals()['UnifiedId'] = UnifiedId + + +class UpdateOrderResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """UpdateOrderResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """UpdateOrderResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/update_order_type_response.py b/src/apideck/model/update_order_type_response.py new file mode 100644 index 0000000000..435bbf9364 --- /dev/null +++ b/src/apideck/model/update_order_type_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_id import UnifiedId + globals()['UnifiedId'] = UnifiedId + + +class UpdateOrderTypeResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """UpdateOrderTypeResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """UpdateOrderTypeResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/update_payment_response.py b/src/apideck/model/update_payment_response.py new file mode 100644 index 0000000000..72294182f3 --- /dev/null +++ b/src/apideck/model/update_payment_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_id import UnifiedId + globals()['UnifiedId'] = UnifiedId + + +class UpdatePaymentResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """UpdatePaymentResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """UpdatePaymentResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/update_pipeline_response.py b/src/apideck/model/update_pipeline_response.py new file mode 100644 index 0000000000..f6bdcc2be3 --- /dev/null +++ b/src/apideck/model/update_pipeline_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_id import UnifiedId + globals()['UnifiedId'] = UnifiedId + + +class UpdatePipelineResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """UpdatePipelineResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """UpdatePipelineResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/update_pos_payment_response.py b/src/apideck/model/update_pos_payment_response.py new file mode 100644 index 0000000000..9d52312709 --- /dev/null +++ b/src/apideck/model/update_pos_payment_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_id import UnifiedId + globals()['UnifiedId'] = UnifiedId + + +class UpdatePosPaymentResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """UpdatePosPaymentResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """UpdatePosPaymentResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/update_shared_link_response.py b/src/apideck/model/update_shared_link_response.py new file mode 100644 index 0000000000..6954c7c00a --- /dev/null +++ b/src/apideck/model/update_shared_link_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_id import UnifiedId + globals()['UnifiedId'] = UnifiedId + + +class UpdateSharedLinkResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """UpdateSharedLinkResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """UpdateSharedLinkResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/update_supplier_response.py b/src/apideck/model/update_supplier_response.py new file mode 100644 index 0000000000..903e8fd21a --- /dev/null +++ b/src/apideck/model/update_supplier_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_id import UnifiedId + globals()['UnifiedId'] = UnifiedId + + +class UpdateSupplierResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """UpdateSupplierResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """UpdateSupplierResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/update_tax_rate_response.py b/src/apideck/model/update_tax_rate_response.py new file mode 100644 index 0000000000..5aaf279abe --- /dev/null +++ b/src/apideck/model/update_tax_rate_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_id import UnifiedId + globals()['UnifiedId'] = UnifiedId + + +class UpdateTaxRateResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """UpdateTaxRateResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """UpdateTaxRateResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/update_tender_response.py b/src/apideck/model/update_tender_response.py new file mode 100644 index 0000000000..ef5d93a1fa --- /dev/null +++ b/src/apideck/model/update_tender_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_id import UnifiedId + globals()['UnifiedId'] = UnifiedId + + +class UpdateTenderResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """UpdateTenderResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """UpdateTenderResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/update_time_off_request_response.py b/src/apideck/model/update_time_off_request_response.py new file mode 100644 index 0000000000..f721f376e0 --- /dev/null +++ b/src/apideck/model/update_time_off_request_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_id import UnifiedId + globals()['UnifiedId'] = UnifiedId + + +class UpdateTimeOffRequestResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """UpdateTimeOffRequestResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """UpdateTimeOffRequestResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/update_upload_session_response.py b/src/apideck/model/update_upload_session_response.py new file mode 100644 index 0000000000..7aee3dc2a8 --- /dev/null +++ b/src/apideck/model/update_upload_session_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_id import UnifiedId + globals()['UnifiedId'] = UnifiedId + + +class UpdateUploadSessionResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """UpdateUploadSessionResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """UpdateUploadSessionResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/update_user_response.py b/src/apideck/model/update_user_response.py new file mode 100644 index 0000000000..60e99fa0f1 --- /dev/null +++ b/src/apideck/model/update_user_response.py @@ -0,0 +1,297 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_id import UnifiedId + globals()['UnifiedId'] = UnifiedId + + +class UpdateUserResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'service': (str,), # noqa: E501 + 'resource': (str,), # noqa: E501 + 'operation': (str,), # noqa: E501 + 'data': (UnifiedId,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'service': 'service', # noqa: E501 + 'resource': 'resource', # noqa: E501 + 'operation': 'operation', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """UpdateUserResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, service, resource, operation, data, *args, **kwargs): # noqa: E501 + """UpdateUserResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + service (str): Apideck ID of service provider + resource (str): Unified API resource name + operation (str): Operation performed + data (UnifiedId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.service = service + self.resource = resource + self.operation = operation + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/update_webhook_request.py b/src/apideck/model/update_webhook_request.py new file mode 100644 index 0000000000..16bd338638 --- /dev/null +++ b/src/apideck/model/update_webhook_request.py @@ -0,0 +1,270 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.delivery_url import DeliveryUrl + from apideck.model.status import Status + from apideck.model.webhook_event_type import WebhookEventType + globals()['DeliveryUrl'] = DeliveryUrl + globals()['Status'] = Status + globals()['WebhookEventType'] = WebhookEventType + + +class UpdateWebhookRequest(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'description': (str, none_type,), # noqa: E501 + 'status': (Status,), # noqa: E501 + 'delivery_url': (DeliveryUrl,), # noqa: E501 + 'events': ([WebhookEventType],), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'description': 'description', # noqa: E501 + 'status': 'status', # noqa: E501 + 'delivery_url': 'delivery_url', # noqa: E501 + 'events': 'events', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """UpdateWebhookRequest - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + description (str, none_type): [optional] # noqa: E501 + status (Status): [optional] # noqa: E501 + delivery_url (DeliveryUrl): [optional] # noqa: E501 + events ([WebhookEventType]): The list of subscribed events for this webhook. [`*`] indicates that all events are enabled.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """UpdateWebhookRequest - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + description (str, none_type): [optional] # noqa: E501 + status (Status): [optional] # noqa: E501 + delivery_url (DeliveryUrl): [optional] # noqa: E501 + events ([WebhookEventType]): The list of subscribed events for this webhook. [`*`] indicates that all events are enabled.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/update_webhook_response.py b/src/apideck/model/update_webhook_response.py new file mode 100644 index 0000000000..beae328407 --- /dev/null +++ b/src/apideck/model/update_webhook_response.py @@ -0,0 +1,279 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.webhook import Webhook + globals()['Webhook'] = Webhook + + +class UpdateWebhookResponse(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'status_code': (int,), # noqa: E501 + 'status': (str,), # noqa: E501 + 'data': (Webhook,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status_code': 'status_code', # noqa: E501 + 'status': 'status', # noqa: E501 + 'data': 'data', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, status_code, status, data, *args, **kwargs): # noqa: E501 + """UpdateWebhookResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + data (Webhook): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, status_code, status, data, *args, **kwargs): # noqa: E501 + """UpdateWebhookResponse - a model defined in OpenAPI + + Args: + status_code (int): HTTP Response Status Code + status (str): HTTP Response Status + data (Webhook): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.status_code = status_code + self.status = status + self.data = data + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/upload_session.py b/src/apideck/model/upload_session.py new file mode 100644 index 0000000000..91bde8d6fa --- /dev/null +++ b/src/apideck/model/upload_session.py @@ -0,0 +1,275 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class UploadSession(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'id': (str,), # noqa: E501 + 'success': (bool,), # noqa: E501 + 'part_size': (float,), # noqa: E501 + 'parallel_upload_supported': (bool,), # noqa: E501 + 'uploaded_byte_range': (str,), # noqa: E501 + 'expires_at': (datetime,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'success': 'success', # noqa: E501 + 'part_size': 'part_size', # noqa: E501 + 'parallel_upload_supported': 'parallel_upload_supported', # noqa: E501 + 'uploaded_byte_range': 'uploaded_byte_range', # noqa: E501 + 'expires_at': 'expires_at', # noqa: E501 + } + + read_only_vars = { + 'id', # noqa: E501 + 'success', # noqa: E501 + 'part_size', # noqa: E501 + 'parallel_upload_supported', # noqa: E501 + 'uploaded_byte_range', # noqa: E501 + 'expires_at', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """UploadSession - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + success (bool): Indicates if the upload session was completed successfully.. [optional] # noqa: E501 + part_size (float): Size in bytes of each part of the file that you will upload. Uploaded parts need to be this size for the upload to be successful.. [optional] # noqa: E501 + parallel_upload_supported (bool): Indicates if parts of the file can uploaded in parallel.. [optional] # noqa: E501 + uploaded_byte_range (str): The range of bytes that was successfully uploaded.. [optional] # noqa: E501 + expires_at (datetime): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """UploadSession - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + success (bool): Indicates if the upload session was completed successfully.. [optional] # noqa: E501 + part_size (float): Size in bytes of each part of the file that you will upload. Uploaded parts need to be this size for the upload to be successful.. [optional] # noqa: E501 + parallel_upload_supported (bool): Indicates if parts of the file can uploaded in parallel.. [optional] # noqa: E501 + uploaded_byte_range (str): The range of bytes that was successfully uploaded.. [optional] # noqa: E501 + expires_at (datetime): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/url.py b/src/apideck/model/url.py new file mode 100644 index 0000000000..757a0a4e5e --- /dev/null +++ b/src/apideck/model/url.py @@ -0,0 +1,283 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class Url(ModelSimple): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + ('value',): { + 'regex': { + 'pattern': r'', # noqa: E501 + }, + }, + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'value': (str,), + } + + @cached_property + def discriminator(): + return None + + + attribute_map = {} + + read_only_vars = set() + + _composed_schemas = None + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): + """Url - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] (str): The url pointing to the job.. # noqa: E501 + + Keyword Args: + value (str): The url pointing to the job.. # noqa: E501 + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + self.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): + """Url - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] (str): The url pointing to the job.. # noqa: E501 + + Keyword Args: + value (str): The url pointing to the job.. # noqa: E501 + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + self.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + return self diff --git a/src/apideck/model/user.py b/src/apideck/model/user.py new file mode 100644 index 0000000000..4eabeda6e1 --- /dev/null +++ b/src/apideck/model/user.py @@ -0,0 +1,350 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.address import Address + from apideck.model.email import Email + from apideck.model.phone_number import PhoneNumber + globals()['Address'] = Address + globals()['Email'] = Email + globals()['PhoneNumber'] = PhoneNumber + + +class User(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'emails': ([Email],), # noqa: E501 + 'id': (str,), # noqa: E501 + 'parent_id': (str, none_type,), # noqa: E501 + 'username': (str, none_type,), # noqa: E501 + 'first_name': (str, none_type,), # noqa: E501 + 'last_name': (str, none_type,), # noqa: E501 + 'title': (str, none_type,), # noqa: E501 + 'division': (str, none_type,), # noqa: E501 + 'department': (str, none_type,), # noqa: E501 + 'company_name': (str, none_type,), # noqa: E501 + 'employee_number': (str, none_type,), # noqa: E501 + 'description': (str, none_type,), # noqa: E501 + 'image': (str, none_type,), # noqa: E501 + 'language': (str, none_type,), # noqa: E501 + 'status': (str, none_type,), # noqa: E501 + 'password': (str,), # noqa: E501 + 'addresses': ([Address],), # noqa: E501 + 'phone_numbers': ([PhoneNumber],), # noqa: E501 + 'updated_at': (str,), # noqa: E501 + 'created_at': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'emails': 'emails', # noqa: E501 + 'id': 'id', # noqa: E501 + 'parent_id': 'parent_id', # noqa: E501 + 'username': 'username', # noqa: E501 + 'first_name': 'first_name', # noqa: E501 + 'last_name': 'last_name', # noqa: E501 + 'title': 'title', # noqa: E501 + 'division': 'division', # noqa: E501 + 'department': 'department', # noqa: E501 + 'company_name': 'company_name', # noqa: E501 + 'employee_number': 'employee_number', # noqa: E501 + 'description': 'description', # noqa: E501 + 'image': 'image', # noqa: E501 + 'language': 'language', # noqa: E501 + 'status': 'status', # noqa: E501 + 'password': 'password', # noqa: E501 + 'addresses': 'addresses', # noqa: E501 + 'phone_numbers': 'phone_numbers', # noqa: E501 + 'updated_at': 'updated_at', # noqa: E501 + 'created_at': 'created_at', # noqa: E501 + } + + read_only_vars = { + 'id', # noqa: E501 + 'updated_at', # noqa: E501 + 'created_at', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, emails, *args, **kwargs): # noqa: E501 + """User - a model defined in OpenAPI + + Args: + emails ([Email]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + parent_id (str, none_type): [optional] # noqa: E501 + username (str, none_type): [optional] # noqa: E501 + first_name (str, none_type): [optional] # noqa: E501 + last_name (str, none_type): [optional] # noqa: E501 + title (str, none_type): [optional] # noqa: E501 + division (str, none_type): The division the user is currently in.. [optional] # noqa: E501 + department (str, none_type): The department the user is currently in.. [optional] # noqa: E501 + company_name (str, none_type): [optional] # noqa: E501 + employee_number (str, none_type): An Employee Number, Employee ID or Employee Code, is a unique number that has been assigned to each individual staff member within a company.. [optional] # noqa: E501 + description (str, none_type): [optional] # noqa: E501 + image (str, none_type): [optional] # noqa: E501 + language (str, none_type): language code according to ISO 639-1. For the United States - EN. [optional] # noqa: E501 + status (str, none_type): [optional] # noqa: E501 + password (str): [optional] # noqa: E501 + addresses ([Address]): [optional] # noqa: E501 + phone_numbers ([PhoneNumber]): [optional] # noqa: E501 + updated_at (str): [optional] # noqa: E501 + created_at (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.emails = emails + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, emails, *args, **kwargs): # noqa: E501 + """User - a model defined in OpenAPI + + Args: + emails ([Email]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + parent_id (str, none_type): [optional] # noqa: E501 + username (str, none_type): [optional] # noqa: E501 + first_name (str, none_type): [optional] # noqa: E501 + last_name (str, none_type): [optional] # noqa: E501 + title (str, none_type): [optional] # noqa: E501 + division (str, none_type): The division the user is currently in.. [optional] # noqa: E501 + department (str, none_type): The department the user is currently in.. [optional] # noqa: E501 + company_name (str, none_type): [optional] # noqa: E501 + employee_number (str, none_type): An Employee Number, Employee ID or Employee Code, is a unique number that has been assigned to each individual staff member within a company.. [optional] # noqa: E501 + description (str, none_type): [optional] # noqa: E501 + image (str, none_type): [optional] # noqa: E501 + language (str, none_type): language code according to ISO 639-1. For the United States - EN. [optional] # noqa: E501 + status (str, none_type): [optional] # noqa: E501 + password (str): [optional] # noqa: E501 + addresses ([Address]): [optional] # noqa: E501 + phone_numbers ([PhoneNumber]): [optional] # noqa: E501 + updated_at (str): [optional] # noqa: E501 + created_at (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.emails = emails + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/vault_event_type.py b/src/apideck/model/vault_event_type.py new file mode 100644 index 0000000000..f33dbda9f5 --- /dev/null +++ b/src/apideck/model/vault_event_type.py @@ -0,0 +1,287 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class VaultEventType(ModelSimple): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('value',): { + '*': "*", + 'VAULT.CONNECTION.CREATED': "vault.connection.created", + 'VAULT.CONNECTION.UPDATED': "vault.connection.updated", + 'VAULT.CONNECTION.DISABLED': "vault.connection.disabled", + 'VAULT.CONNECTION.DELETED': "vault.connection.deleted", + 'VAULT.CONNECTION.CALLABLE': "vault.connection.callable", + 'VAULT.CONNECTION.TOKEN_REFRESH.FAILED': "vault.connection.token_refresh.failed", + }, + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'value': (str,), + } + + @cached_property + def discriminator(): + return None + + + attribute_map = {} + + read_only_vars = set() + + _composed_schemas = None + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): + """VaultEventType - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] (str):, must be one of ["*", "vault.connection.created", "vault.connection.updated", "vault.connection.disabled", "vault.connection.deleted", "vault.connection.callable", "vault.connection.token_refresh.failed", ] # noqa: E501 + + Keyword Args: + value (str):, must be one of ["*", "vault.connection.created", "vault.connection.updated", "vault.connection.disabled", "vault.connection.deleted", "vault.connection.callable", "vault.connection.token_refresh.failed", ] # noqa: E501 + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + self.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): + """VaultEventType - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] (str):, must be one of ["*", "vault.connection.created", "vault.connection.updated", "vault.connection.disabled", "vault.connection.deleted", "vault.connection.callable", "vault.connection.token_refresh.failed", ] # noqa: E501 + + Keyword Args: + value (str):, must be one of ["*", "vault.connection.created", "vault.connection.updated", "vault.connection.disabled", "vault.connection.deleted", "vault.connection.callable", "vault.connection.token_refresh.failed", ] # noqa: E501 + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + self.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + return self diff --git a/src/apideck/model/wallet_details.py b/src/apideck/model/wallet_details.py new file mode 100644 index 0000000000..22773d90ab --- /dev/null +++ b/src/apideck/model/wallet_details.py @@ -0,0 +1,265 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class WalletDetails(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('status',): { + 'AUTHORIZED': "authorized", + 'CAPTURED': "captured", + 'VOIDED': "voided", + 'FAILED': "failed", + 'OTHER': "other", + }, + } + + validations = { + ('status',): { + 'max_length': 50, + }, + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'status': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'status': 'status', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """WalletDetails - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + status (str): The status of the wallet payment. The status can be AUTHORIZED, CAPTURED, VOIDED, or FAILED.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """WalletDetails - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + status (str): The status of the wallet payment. The status can be AUTHORIZED, CAPTURED, VOIDED, or FAILED.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/webhook.py b/src/apideck/model/webhook.py new file mode 100644 index 0000000000..8d2fb29c18 --- /dev/null +++ b/src/apideck/model/webhook.py @@ -0,0 +1,311 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.delivery_url import DeliveryUrl + from apideck.model.execute_base_url import ExecuteBaseUrl + from apideck.model.status import Status + from apideck.model.unified_api_id import UnifiedApiId + from apideck.model.webhook_event_type import WebhookEventType + globals()['DeliveryUrl'] = DeliveryUrl + globals()['ExecuteBaseUrl'] = ExecuteBaseUrl + globals()['Status'] = Status + globals()['UnifiedApiId'] = UnifiedApiId + globals()['WebhookEventType'] = WebhookEventType + + +class Webhook(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'unified_api': (UnifiedApiId,), # noqa: E501 + 'status': (Status,), # noqa: E501 + 'delivery_url': (DeliveryUrl,), # noqa: E501 + 'execute_base_url': (ExecuteBaseUrl,), # noqa: E501 + 'events': ([WebhookEventType],), # noqa: E501 + 'id': (str,), # noqa: E501 + 'description': (str, none_type,), # noqa: E501 + 'updated_at': (datetime,), # noqa: E501 + 'created_at': (datetime,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'unified_api': 'unified_api', # noqa: E501 + 'status': 'status', # noqa: E501 + 'delivery_url': 'delivery_url', # noqa: E501 + 'execute_base_url': 'execute_base_url', # noqa: E501 + 'events': 'events', # noqa: E501 + 'id': 'id', # noqa: E501 + 'description': 'description', # noqa: E501 + 'updated_at': 'updated_at', # noqa: E501 + 'created_at': 'created_at', # noqa: E501 + } + + read_only_vars = { + 'id', # noqa: E501 + 'updated_at', # noqa: E501 + 'created_at', # noqa: E501 + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, unified_api, status, delivery_url, execute_base_url, events, *args, **kwargs): # noqa: E501 + """Webhook - a model defined in OpenAPI + + Args: + unified_api (UnifiedApiId): + status (Status): + delivery_url (DeliveryUrl): + execute_base_url (ExecuteBaseUrl): + events ([WebhookEventType]): The list of subscribed events for this webhook. [`*`] indicates that all events are enabled. + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + description (str, none_type): [optional] # noqa: E501 + updated_at (datetime): [optional] # noqa: E501 + created_at (datetime): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.unified_api = unified_api + self.status = status + self.delivery_url = delivery_url + self.execute_base_url = execute_base_url + self.events = events + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, unified_api, status, delivery_url, execute_base_url, events, *args, **kwargs): # noqa: E501 + """Webhook - a model defined in OpenAPI + + Args: + unified_api (UnifiedApiId): + status (Status): + delivery_url (DeliveryUrl): + execute_base_url (ExecuteBaseUrl): + events ([WebhookEventType]): The list of subscribed events for this webhook. [`*`] indicates that all events are enabled. + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + description (str, none_type): [optional] # noqa: E501 + updated_at (datetime): [optional] # noqa: E501 + created_at (datetime): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.unified_api = unified_api + self.status = status + self.delivery_url = delivery_url + self.execute_base_url = execute_base_url + self.events = events + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/webhook_event_log.py b/src/apideck/model/webhook_event_log.py new file mode 100644 index 0000000000..fc6855cb44 --- /dev/null +++ b/src/apideck/model/webhook_event_log.py @@ -0,0 +1,327 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.unified_api_id import UnifiedApiId + from apideck.model.webhook_event_log_attempts import WebhookEventLogAttempts + from apideck.model.webhook_event_log_service import WebhookEventLogService + globals()['UnifiedApiId'] = UnifiedApiId + globals()['WebhookEventLogAttempts'] = WebhookEventLogAttempts + globals()['WebhookEventLogService'] = WebhookEventLogService + + +class WebhookEventLog(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + ('endpoint',): { + 'regex': { + 'pattern': r'^(https?):\/\/', # noqa: E501 + }, + }, + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'id': (str,), # noqa: E501 + 'status_code': (int,), # noqa: E501 + 'success': (bool,), # noqa: E501 + 'application_id': (str,), # noqa: E501 + 'consumer_id': (str,), # noqa: E501 + 'unified_api': (UnifiedApiId,), # noqa: E501 + 'service': (WebhookEventLogService,), # noqa: E501 + 'endpoint': (str,), # noqa: E501 + 'event_type': (str,), # noqa: E501 + 'execution_attempt': (float,), # noqa: E501 + 'http_method': (str,), # noqa: E501 + 'timestamp': (str,), # noqa: E501 + 'entity_type': (str,), # noqa: E501 + 'request_body': (str,), # noqa: E501 + 'response_body': (str,), # noqa: E501 + 'retry_scheduled': (bool,), # noqa: E501 + 'attempts': ([WebhookEventLogAttempts],), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'status_code': 'status_code', # noqa: E501 + 'success': 'success', # noqa: E501 + 'application_id': 'application_id', # noqa: E501 + 'consumer_id': 'consumer_id', # noqa: E501 + 'unified_api': 'unified_api', # noqa: E501 + 'service': 'service', # noqa: E501 + 'endpoint': 'endpoint', # noqa: E501 + 'event_type': 'event_type', # noqa: E501 + 'execution_attempt': 'execution_attempt', # noqa: E501 + 'http_method': 'http_method', # noqa: E501 + 'timestamp': 'timestamp', # noqa: E501 + 'entity_type': 'entity_type', # noqa: E501 + 'request_body': 'request_body', # noqa: E501 + 'response_body': 'response_body', # noqa: E501 + 'retry_scheduled': 'retry_scheduled', # noqa: E501 + 'attempts': 'attempts', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """WebhookEventLog - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + status_code (int): HTTP Status code that was returned.. [optional] # noqa: E501 + success (bool): Whether or not the request was successful.. [optional] # noqa: E501 + application_id (str): ID of your Apideck Application. [optional] # noqa: E501 + consumer_id (str): Consumer identifier. [optional] # noqa: E501 + unified_api (UnifiedApiId): [optional] # noqa: E501 + service (WebhookEventLogService): [optional] # noqa: E501 + endpoint (str): The URL of the webhook endpoint.. [optional] # noqa: E501 + event_type (str): Name of source event that webhook is subscribed to.. [optional] # noqa: E501 + execution_attempt (float): Number of attempts webhook endpoint was called before a success was returned or eventually failed. [optional] # noqa: E501 + http_method (str): HTTP Method of request to endpoint.. [optional] # noqa: E501 + timestamp (str): ISO Date and time when the request was made.. [optional] # noqa: E501 + entity_type (str): Name of the Entity described by the attributes delivered within payload. [optional] # noqa: E501 + request_body (str): The JSON stringified payload that was delivered to the webhook endpoint.. [optional] # noqa: E501 + response_body (str): The JSON stringified response that was returned from the webhook endpoint.. [optional] # noqa: E501 + retry_scheduled (bool): If the request has not hit the max retry limit and will be retried.. [optional] # noqa: E501 + attempts ([WebhookEventLogAttempts]): record of each attempt to call webhook endpoint. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """WebhookEventLog - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + status_code (int): HTTP Status code that was returned.. [optional] # noqa: E501 + success (bool): Whether or not the request was successful.. [optional] # noqa: E501 + application_id (str): ID of your Apideck Application. [optional] # noqa: E501 + consumer_id (str): Consumer identifier. [optional] # noqa: E501 + unified_api (UnifiedApiId): [optional] # noqa: E501 + service (WebhookEventLogService): [optional] # noqa: E501 + endpoint (str): The URL of the webhook endpoint.. [optional] # noqa: E501 + event_type (str): Name of source event that webhook is subscribed to.. [optional] # noqa: E501 + execution_attempt (float): Number of attempts webhook endpoint was called before a success was returned or eventually failed. [optional] # noqa: E501 + http_method (str): HTTP Method of request to endpoint.. [optional] # noqa: E501 + timestamp (str): ISO Date and time when the request was made.. [optional] # noqa: E501 + entity_type (str): Name of the Entity described by the attributes delivered within payload. [optional] # noqa: E501 + request_body (str): The JSON stringified payload that was delivered to the webhook endpoint.. [optional] # noqa: E501 + response_body (str): The JSON stringified response that was returned from the webhook endpoint.. [optional] # noqa: E501 + retry_scheduled (bool): If the request has not hit the max retry limit and will be retried.. [optional] # noqa: E501 + attempts ([WebhookEventLogAttempts]): record of each attempt to call webhook endpoint. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/webhook_event_log_attempts.py b/src/apideck/model/webhook_event_log_attempts.py new file mode 100644 index 0000000000..73d7ec3e81 --- /dev/null +++ b/src/apideck/model/webhook_event_log_attempts.py @@ -0,0 +1,267 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class WebhookEventLogAttempts(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'timestamp': (str,), # noqa: E501 + 'execution_attempt': (float,), # noqa: E501 + 'status_code': (int,), # noqa: E501 + 'success': (bool,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'timestamp': 'timestamp', # noqa: E501 + 'execution_attempt': 'execution_attempt', # noqa: E501 + 'status_code': 'status_code', # noqa: E501 + 'success': 'success', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """WebhookEventLogAttempts - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + timestamp (str): ISO Date and time when the request was made.. [optional] # noqa: E501 + execution_attempt (float): Number of attempts webhook endpoint was called before a success was returned or eventually failed. [optional] # noqa: E501 + status_code (int): HTTP Status code that was returned.. [optional] # noqa: E501 + success (bool): Whether or not the request was successful.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """WebhookEventLogAttempts - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + timestamp (str): ISO Date and time when the request was made.. [optional] # noqa: E501 + execution_attempt (float): Number of attempts webhook endpoint was called before a success was returned or eventually failed. [optional] # noqa: E501 + status_code (int): HTTP Status code that was returned.. [optional] # noqa: E501 + success (bool): Whether or not the request was successful.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/webhook_event_log_service.py b/src/apideck/model/webhook_event_log_service.py new file mode 100644 index 0000000000..0f1aa17f76 --- /dev/null +++ b/src/apideck/model/webhook_event_log_service.py @@ -0,0 +1,267 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class WebhookEventLogService(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'id': (str,), # noqa: E501 + 'name': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + 'name': 'name', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, id, name, *args, **kwargs): # noqa: E501 + """WebhookEventLogService - a model defined in OpenAPI + + Args: + id (str): Apideck service provider id. + name (str): Apideck service provider name. + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.id = id + self.name = name + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, id, name, *args, **kwargs): # noqa: E501 + """WebhookEventLogService - a model defined in OpenAPI + + Args: + id (str): Apideck service provider id. + name (str): Apideck service provider name. + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.id = id + self.name = name + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/webhook_event_logs_filter.py b/src/apideck/model/webhook_event_logs_filter.py new file mode 100644 index 0000000000..afd36df3d6 --- /dev/null +++ b/src/apideck/model/webhook_event_logs_filter.py @@ -0,0 +1,277 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + +def lazy_import(): + from apideck.model.webhook_event_logs_filter_service import WebhookEventLogsFilterService + globals()['WebhookEventLogsFilterService'] = WebhookEventLogsFilterService + + +class WebhookEventLogsFilter(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'exclude_apis': (str, none_type,), # noqa: E501 + 'service': (WebhookEventLogsFilterService,), # noqa: E501 + 'consumer_id': (str, none_type,), # noqa: E501 + 'entity_type': (str, none_type,), # noqa: E501 + 'event_type': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'exclude_apis': 'exclude_apis', # noqa: E501 + 'service': 'service', # noqa: E501 + 'consumer_id': 'consumer_id', # noqa: E501 + 'entity_type': 'entity_type', # noqa: E501 + 'event_type': 'event_type', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """WebhookEventLogsFilter - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + exclude_apis (str, none_type): [optional] # noqa: E501 + service (WebhookEventLogsFilterService): [optional] # noqa: E501 + consumer_id (str, none_type): [optional] # noqa: E501 + entity_type (str, none_type): [optional] # noqa: E501 + event_type (str, none_type): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """WebhookEventLogsFilter - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + exclude_apis (str, none_type): [optional] # noqa: E501 + service (WebhookEventLogsFilterService): [optional] # noqa: E501 + consumer_id (str, none_type): [optional] # noqa: E501 + entity_type (str, none_type): [optional] # noqa: E501 + event_type (str, none_type): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/webhook_event_logs_filter_service.py b/src/apideck/model/webhook_event_logs_filter_service.py new file mode 100644 index 0000000000..9614e812cf --- /dev/null +++ b/src/apideck/model/webhook_event_logs_filter_service.py @@ -0,0 +1,255 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class WebhookEventLogsFilterService(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = True + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'id': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'id': 'id', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """WebhookEventLogsFilterService - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """WebhookEventLogsFilterService - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/webhook_event_type.py b/src/apideck/model/webhook_event_type.py new file mode 100644 index 0000000000..695234d138 --- /dev/null +++ b/src/apideck/model/webhook_event_type.py @@ -0,0 +1,371 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class WebhookEventType(ModelSimple): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('value',): { + '*': "*", + 'CRM.ACTIVITY.CREATED': "crm.activity.created", + 'CRM.ACTIVITY.UPDATED': "crm.activity.updated", + 'CRM.ACTIVITY.DELETED': "crm.activity.deleted", + 'CRM.COMPANY.CREATED': "crm.company.created", + 'CRM.COMPANY.UPDATED': "crm.company.updated", + 'CRM.COMPANY.DELETED': "crm.company.deleted", + 'CRM.CONTACT.CREATED': "crm.contact.created", + 'CRM.CONTACT.UPDATED': "crm.contact.updated", + 'CRM.CONTACT.DELETED': "crm.contact.deleted", + 'CRM.LEAD.CREATED': "crm.lead.created", + 'CRM.LEAD.UPDATED': "crm.lead.updated", + 'CRM.LEAD.DELETED': "crm.lead.deleted", + 'CRM.NOTE.CREATED': "crm.note.created", + 'CRM.NOTES.UPDATED': "crm.notes.updated", + 'CRM.NOTES.DELETED': "crm.notes.deleted", + 'CRM.OPPORTUNITY.CREATED': "crm.opportunity.created", + 'CRM.OPPORTUNITY.UPDATED': "crm.opportunity.updated", + 'CRM.OPPORTUNITY.DELETED': "crm.opportunity.deleted", + 'LEAD.LEAD.CREATED': "lead.lead.created", + 'LEAD.LEAD.UPDATED': "lead.lead.updated", + 'LEAD.LEAD.DELETED': "lead.lead.deleted", + 'VAULT.CONNECTION.CREATED': "vault.connection.created", + 'VAULT.CONNECTION.UPDATED': "vault.connection.updated", + 'VAULT.CONNECTION.DISABLED': "vault.connection.disabled", + 'VAULT.CONNECTION.DELETED': "vault.connection.deleted", + 'VAULT.CONNECTION.CALLABLE': "vault.connection.callable", + 'VAULT.CONNECTION.TOKEN_REFRESH.FAILED': "vault.connection.token_refresh.failed", + 'ATS.JOB.CREATED': "ats.job.created", + 'ATS.JOB.UPDATED': "ats.job.updated", + 'ATS.JOB.DELETED': "ats.job.deleted", + 'ATS.APPLICANT.CREATED': "ats.applicant.created", + 'ATS.APPLICANT.UPDATED': "ats.applicant.updated", + 'ATS.APPLICANT.DELETED': "ats.applicant.deleted", + 'ACCOUNTING.CUSTOMER.CREATED': "accounting.customer.created", + 'ACCOUNTING.CUSTOMER.UPDATED': "accounting.customer.updated", + 'ACCOUNTING.CUSTOMER.DELETED': "accounting.customer.deleted", + 'ACCOUNTING.INVOICE.CREATED': "accounting.invoice.created", + 'ACCOUNTING.INVOICE.UPDATED': "accounting.invoice.updated", + 'ACCOUNTING.INVOICE.DELETED': "accounting.invoice.deleted", + 'ACCOUNTING.INVOICE_ITEM.CREATED': "accounting.invoice_item.created", + 'ACCOUNTING.INVOICE_ITEM.UPDATED': "accounting.invoice_item.updated", + 'ACCOUNTING.INVOICE_ITEM.DELETED': "accounting.invoice_item.deleted", + 'ACCOUNTING.LEDGER_ACCOUNT.CREATED': "accounting.ledger_account.created", + 'ACCOUNTING.LEDGER_ACCOUNT.UPDATED': "accounting.ledger_account.updated", + 'ACCOUNTING.LEDGER_ACCOUNT.DELETED': "accounting.ledger_account.deleted", + 'ACCOUNTING.TAX_RATE.CREATED': "accounting.tax_rate.created", + 'ACCOUNTING.TAX_RATE.UPDATED': "accounting.tax_rate.updated", + 'ACCOUNTING.TAX_RATE.DELETED': "accounting.tax_rate.deleted", + 'ACCOUNTING.BILL.CREATED': "accounting.bill.created", + 'ACCOUNTING.BILL.UPDATED': "accounting.bill.updated", + 'ACCOUNTING.BILL.DELETED': "accounting.bill.deleted", + 'ACCOUNTING.PAYMENT.CREATED': "accounting.payment.created", + 'ACCOUNTING.PAYMENT.UPDATED': "accounting.payment.updated", + 'ACCOUNTING.PAYMENT.DELETED': "accounting.payment.deleted", + 'ACCOUNTING.SUPPLIER.CREATED': "accounting.supplier.created", + 'ACCOUNTING.SUPPLIER.UPDATED': "accounting.supplier.updated", + 'ACCOUNTING.SUPPLIER.DELETED': "accounting.supplier.deleted", + 'POS.ORDER.CREATED': "pos.order.created", + 'POS.ORDER.UPDATED': "pos.order.updated", + 'POS.ORDER.DELETED': "pos.order.deleted", + 'POS.PRODUCT.CREATED': "pos.product.created", + 'POS.PRODUCT.UPDATED': "pos.product.updated", + 'POS.PRODUCT.DELETED': "pos.product.deleted", + 'POS.PAYMENT.CREATED': "pos.payment.created", + 'POS.PAYMENT.UPDATED': "pos.payment.updated", + 'POS.PAYMENT.DELETED': "pos.payment.deleted", + 'POS.MERCHANT.CREATED': "pos.merchant.created", + 'POS.MERCHANT.UPDATED': "pos.merchant.updated", + 'POS.MERCHANT.DELETED': "pos.merchant.deleted", + 'POS.LOCATION.CREATED': "pos.location.created", + 'POS.LOCATION.UPDATED': "pos.location.updated", + 'POS.LOCATION.DELETED': "pos.location.deleted", + 'POS.ITEM.CREATED': "pos.item.created", + 'POS.ITEM.UPDATED': "pos.item.updated", + 'POS.ITEM.DELETED': "pos.item.deleted", + 'POS.MODIFIER.CREATED': "pos.modifier.created", + 'POS.MODIFIER.UPDATED': "pos.modifier.updated", + 'POS.MODIFIER.DELETED': "pos.modifier.deleted", + 'POS.MODIFIER-GROUP.CREATED': "pos.modifier-group.created", + 'POS.MODIFIER-GROUP.UPDATED': "pos.modifier-group.updated", + 'POS.MODIFIER-GROUP.DELETED': "pos.modifier-group.deleted", + 'HRIS.EMPLOYEE.CREATED': "hris.employee.created", + 'HRIS.EMPLOYEE.UPDATED': "hris.employee.updated", + 'HRIS.EMPLOYEE.DELETED': "hris.employee.deleted", + 'HRIS.COMPANY.CREATED': "hris.company.created", + 'HRIS.COMPANY.UPDATED': "hris.company.updated", + 'HRIS.COMPANY.DELETED': "hris.company.deleted", + 'FILE-STORAGE.FILE.CREATED': "file-storage.file.created", + 'FILE-STORAGE.FILE.UPDATED': "file-storage.file.updated", + 'FILE-STORAGE.FILE.DELETED': "file-storage.file.deleted", + }, + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'value': (str,), + } + + @cached_property + def discriminator(): + return None + + + attribute_map = {} + + read_only_vars = set() + + _composed_schemas = None + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): + """WebhookEventType - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] (str):, must be one of ["*", "crm.activity.created", "crm.activity.updated", "crm.activity.deleted", "crm.company.created", "crm.company.updated", "crm.company.deleted", "crm.contact.created", "crm.contact.updated", "crm.contact.deleted", "crm.lead.created", "crm.lead.updated", "crm.lead.deleted", "crm.note.created", "crm.notes.updated", "crm.notes.deleted", "crm.opportunity.created", "crm.opportunity.updated", "crm.opportunity.deleted", "lead.lead.created", "lead.lead.updated", "lead.lead.deleted", "vault.connection.created", "vault.connection.updated", "vault.connection.disabled", "vault.connection.deleted", "vault.connection.callable", "vault.connection.token_refresh.failed", "ats.job.created", "ats.job.updated", "ats.job.deleted", "ats.applicant.created", "ats.applicant.updated", "ats.applicant.deleted", "accounting.customer.created", "accounting.customer.updated", "accounting.customer.deleted", "accounting.invoice.created", "accounting.invoice.updated", "accounting.invoice.deleted", "accounting.invoice_item.created", "accounting.invoice_item.updated", "accounting.invoice_item.deleted", "accounting.ledger_account.created", "accounting.ledger_account.updated", "accounting.ledger_account.deleted", "accounting.tax_rate.created", "accounting.tax_rate.updated", "accounting.tax_rate.deleted", "accounting.bill.created", "accounting.bill.updated", "accounting.bill.deleted", "accounting.payment.created", "accounting.payment.updated", "accounting.payment.deleted", "accounting.supplier.created", "accounting.supplier.updated", "accounting.supplier.deleted", "pos.order.created", "pos.order.updated", "pos.order.deleted", "pos.product.created", "pos.product.updated", "pos.product.deleted", "pos.payment.created", "pos.payment.updated", "pos.payment.deleted", "pos.merchant.created", "pos.merchant.updated", "pos.merchant.deleted", "pos.location.created", "pos.location.updated", "pos.location.deleted", "pos.item.created", "pos.item.updated", "pos.item.deleted", "pos.modifier.created", "pos.modifier.updated", "pos.modifier.deleted", "pos.modifier-group.created", "pos.modifier-group.updated", "pos.modifier-group.deleted", "hris.employee.created", "hris.employee.updated", "hris.employee.deleted", "hris.company.created", "hris.company.updated", "hris.company.deleted", "file-storage.file.created", "file-storage.file.updated", "file-storage.file.deleted", ] # noqa: E501 + + Keyword Args: + value (str):, must be one of ["*", "crm.activity.created", "crm.activity.updated", "crm.activity.deleted", "crm.company.created", "crm.company.updated", "crm.company.deleted", "crm.contact.created", "crm.contact.updated", "crm.contact.deleted", "crm.lead.created", "crm.lead.updated", "crm.lead.deleted", "crm.note.created", "crm.notes.updated", "crm.notes.deleted", "crm.opportunity.created", "crm.opportunity.updated", "crm.opportunity.deleted", "lead.lead.created", "lead.lead.updated", "lead.lead.deleted", "vault.connection.created", "vault.connection.updated", "vault.connection.disabled", "vault.connection.deleted", "vault.connection.callable", "vault.connection.token_refresh.failed", "ats.job.created", "ats.job.updated", "ats.job.deleted", "ats.applicant.created", "ats.applicant.updated", "ats.applicant.deleted", "accounting.customer.created", "accounting.customer.updated", "accounting.customer.deleted", "accounting.invoice.created", "accounting.invoice.updated", "accounting.invoice.deleted", "accounting.invoice_item.created", "accounting.invoice_item.updated", "accounting.invoice_item.deleted", "accounting.ledger_account.created", "accounting.ledger_account.updated", "accounting.ledger_account.deleted", "accounting.tax_rate.created", "accounting.tax_rate.updated", "accounting.tax_rate.deleted", "accounting.bill.created", "accounting.bill.updated", "accounting.bill.deleted", "accounting.payment.created", "accounting.payment.updated", "accounting.payment.deleted", "accounting.supplier.created", "accounting.supplier.updated", "accounting.supplier.deleted", "pos.order.created", "pos.order.updated", "pos.order.deleted", "pos.product.created", "pos.product.updated", "pos.product.deleted", "pos.payment.created", "pos.payment.updated", "pos.payment.deleted", "pos.merchant.created", "pos.merchant.updated", "pos.merchant.deleted", "pos.location.created", "pos.location.updated", "pos.location.deleted", "pos.item.created", "pos.item.updated", "pos.item.deleted", "pos.modifier.created", "pos.modifier.updated", "pos.modifier.deleted", "pos.modifier-group.created", "pos.modifier-group.updated", "pos.modifier-group.deleted", "hris.employee.created", "hris.employee.updated", "hris.employee.deleted", "hris.company.created", "hris.company.updated", "hris.company.deleted", "file-storage.file.created", "file-storage.file.updated", "file-storage.file.deleted", ] # noqa: E501 + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + self.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): + """WebhookEventType - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] (str):, must be one of ["*", "crm.activity.created", "crm.activity.updated", "crm.activity.deleted", "crm.company.created", "crm.company.updated", "crm.company.deleted", "crm.contact.created", "crm.contact.updated", "crm.contact.deleted", "crm.lead.created", "crm.lead.updated", "crm.lead.deleted", "crm.note.created", "crm.notes.updated", "crm.notes.deleted", "crm.opportunity.created", "crm.opportunity.updated", "crm.opportunity.deleted", "lead.lead.created", "lead.lead.updated", "lead.lead.deleted", "vault.connection.created", "vault.connection.updated", "vault.connection.disabled", "vault.connection.deleted", "vault.connection.callable", "vault.connection.token_refresh.failed", "ats.job.created", "ats.job.updated", "ats.job.deleted", "ats.applicant.created", "ats.applicant.updated", "ats.applicant.deleted", "accounting.customer.created", "accounting.customer.updated", "accounting.customer.deleted", "accounting.invoice.created", "accounting.invoice.updated", "accounting.invoice.deleted", "accounting.invoice_item.created", "accounting.invoice_item.updated", "accounting.invoice_item.deleted", "accounting.ledger_account.created", "accounting.ledger_account.updated", "accounting.ledger_account.deleted", "accounting.tax_rate.created", "accounting.tax_rate.updated", "accounting.tax_rate.deleted", "accounting.bill.created", "accounting.bill.updated", "accounting.bill.deleted", "accounting.payment.created", "accounting.payment.updated", "accounting.payment.deleted", "accounting.supplier.created", "accounting.supplier.updated", "accounting.supplier.deleted", "pos.order.created", "pos.order.updated", "pos.order.deleted", "pos.product.created", "pos.product.updated", "pos.product.deleted", "pos.payment.created", "pos.payment.updated", "pos.payment.deleted", "pos.merchant.created", "pos.merchant.updated", "pos.merchant.deleted", "pos.location.created", "pos.location.updated", "pos.location.deleted", "pos.item.created", "pos.item.updated", "pos.item.deleted", "pos.modifier.created", "pos.modifier.updated", "pos.modifier.deleted", "pos.modifier-group.created", "pos.modifier-group.updated", "pos.modifier-group.deleted", "hris.employee.created", "hris.employee.updated", "hris.employee.deleted", "hris.company.created", "hris.company.updated", "hris.company.deleted", "file-storage.file.created", "file-storage.file.updated", "file-storage.file.deleted", ] # noqa: E501 + + Keyword Args: + value (str):, must be one of ["*", "crm.activity.created", "crm.activity.updated", "crm.activity.deleted", "crm.company.created", "crm.company.updated", "crm.company.deleted", "crm.contact.created", "crm.contact.updated", "crm.contact.deleted", "crm.lead.created", "crm.lead.updated", "crm.lead.deleted", "crm.note.created", "crm.notes.updated", "crm.notes.deleted", "crm.opportunity.created", "crm.opportunity.updated", "crm.opportunity.deleted", "lead.lead.created", "lead.lead.updated", "lead.lead.deleted", "vault.connection.created", "vault.connection.updated", "vault.connection.disabled", "vault.connection.deleted", "vault.connection.callable", "vault.connection.token_refresh.failed", "ats.job.created", "ats.job.updated", "ats.job.deleted", "ats.applicant.created", "ats.applicant.updated", "ats.applicant.deleted", "accounting.customer.created", "accounting.customer.updated", "accounting.customer.deleted", "accounting.invoice.created", "accounting.invoice.updated", "accounting.invoice.deleted", "accounting.invoice_item.created", "accounting.invoice_item.updated", "accounting.invoice_item.deleted", "accounting.ledger_account.created", "accounting.ledger_account.updated", "accounting.ledger_account.deleted", "accounting.tax_rate.created", "accounting.tax_rate.updated", "accounting.tax_rate.deleted", "accounting.bill.created", "accounting.bill.updated", "accounting.bill.deleted", "accounting.payment.created", "accounting.payment.updated", "accounting.payment.deleted", "accounting.supplier.created", "accounting.supplier.updated", "accounting.supplier.deleted", "pos.order.created", "pos.order.updated", "pos.order.deleted", "pos.product.created", "pos.product.updated", "pos.product.deleted", "pos.payment.created", "pos.payment.updated", "pos.payment.deleted", "pos.merchant.created", "pos.merchant.updated", "pos.merchant.deleted", "pos.location.created", "pos.location.updated", "pos.location.deleted", "pos.item.created", "pos.item.updated", "pos.item.deleted", "pos.modifier.created", "pos.modifier.updated", "pos.modifier.deleted", "pos.modifier-group.created", "pos.modifier-group.updated", "pos.modifier-group.deleted", "hris.employee.created", "hris.employee.updated", "hris.employee.deleted", "hris.company.created", "hris.company.updated", "hris.company.deleted", "file-storage.file.created", "file-storage.file.updated", "file-storage.file.deleted", ] # noqa: E501 + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + self.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + return self diff --git a/src/apideck/model/webhook_subscription.py b/src/apideck/model/webhook_subscription.py new file mode 100644 index 0000000000..ec05094cb8 --- /dev/null +++ b/src/apideck/model/webhook_subscription.py @@ -0,0 +1,265 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class WebhookSubscription(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'downstream_id': (str,), # noqa: E501 + 'unify_event_types': ([str],), # noqa: E501 + 'downstream_event_types': ([str],), # noqa: E501 + 'execute_url': (str,), # noqa: E501 + 'created_at': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'downstream_id': 'downstream_id', # noqa: E501 + 'unify_event_types': 'unify_event_types', # noqa: E501 + 'downstream_event_types': 'downstream_event_types', # noqa: E501 + 'execute_url': 'execute_url', # noqa: E501 + 'created_at': 'created_at', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """WebhookSubscription - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + downstream_id (str): The ID of the downstream service. [optional] # noqa: E501 + unify_event_types ([str]): The list of Unify Events this connection is subscribed to. [optional] # noqa: E501 + downstream_event_types ([str]): The list of downstream Events this connection is subscribed to. [optional] # noqa: E501 + execute_url (str): The URL the downstream is sending to when the event is triggered. [optional] # noqa: E501 + created_at (str): The date and time the webhook subscription was created downstream. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """WebhookSubscription - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + downstream_id (str): The ID of the downstream service. [optional] # noqa: E501 + unify_event_types ([str]): The list of Unify Events this connection is subscribed to. [optional] # noqa: E501 + downstream_event_types ([str]): The list of downstream Events this connection is subscribed to. [optional] # noqa: E501 + execute_url (str): The URL the downstream is sending to when the event is triggered. [optional] # noqa: E501 + created_at (str): The date and time the webhook subscription was created downstream. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/webhook_support.py b/src/apideck/model/webhook_support.py new file mode 100644 index 0000000000..d1370cdd1d --- /dev/null +++ b/src/apideck/model/webhook_support.py @@ -0,0 +1,276 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class WebhookSupport(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('mode',): { + 'NATIVE': "native", + 'VIRTUAL': "virtual", + 'NONE': "none", + }, + ('subscription_level',): { + 'CONSUMER': "consumer", + 'INTEGRATION': "integration", + }, + ('managed_via',): { + 'MANUAL': "manual", + 'API': "api", + }, + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'mode': (str,), # noqa: E501 + 'subscription_level': (str,), # noqa: E501 + 'managed_via': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'mode': 'mode', # noqa: E501 + 'subscription_level': 'subscription_level', # noqa: E501 + 'managed_via': 'managed_via', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """WebhookSupport - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + mode (str): Mode of the webhook support.. [optional] # noqa: E501 + subscription_level (str): Received events are scoped to consumer or across integration.. [optional] # noqa: E501 + managed_via (str): How the subscription is managed in the downstream.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """WebhookSupport - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + mode (str): Mode of the webhook support.. [optional] # noqa: E501 + subscription_level (str): Received events are scoped to consumer or across integration.. [optional] # noqa: E501 + managed_via (str): How the subscription is managed in the downstream.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model/website.py b/src/apideck/model/website.py new file mode 100644 index 0000000000..2f3bc866cd --- /dev/null +++ b/src/apideck/model/website.py @@ -0,0 +1,273 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from apideck.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from apideck.exceptions import ApiAttributeError + + + +class Website(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('type',): { + 'PRIMARY': "primary", + 'SECONDARY': "secondary", + 'WORK': "work", + 'PERSONAL': "personal", + 'OTHER': "other", + }, + } + + validations = { + ('url',): { + 'min_length': 1, + }, + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'url': (str,), # noqa: E501 + 'id': (str, none_type,), # noqa: E501 + 'type': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'url': 'url', # noqa: E501 + 'id': 'id', # noqa: E501 + 'type': 'type', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, url, *args, **kwargs): # noqa: E501 + """Website - a model defined in OpenAPI + + Args: + url (str): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str, none_type): [optional] # noqa: E501 + type (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.url = url + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, url, *args, **kwargs): # noqa: E501 + """Website - a model defined in OpenAPI + + Args: + url (str): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + id (str, none_type): [optional] # noqa: E501 + type (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.url = url + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/src/apideck/model_utils.py b/src/apideck/model_utils.py new file mode 100644 index 0000000000..26442f079f --- /dev/null +++ b/src/apideck/model_utils.py @@ -0,0 +1,2037 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +from datetime import date, datetime # noqa: F401 +from copy import deepcopy +import inspect +import io +import os +import pprint +import re +import tempfile + +from dateutil.parser import parse + +from apideck.exceptions import ( + ApiKeyError, + ApiAttributeError, + ApiTypeError, + ApiValueError, +) + +none_type = type(None) +file_type = io.IOBase + + +def convert_js_args_to_python_args(fn): + from functools import wraps + @wraps(fn) + def wrapped_init(_self, *args, **kwargs): + """ + An attribute named `self` received from the api will conflicts with the reserved `self` + parameter of a class method. During generation, `self` attributes are mapped + to `_self` in models. Here, we name `_self` instead of `self` to avoid conflicts. + """ + spec_property_naming = kwargs.get('_spec_property_naming', False) + if spec_property_naming: + kwargs = change_keys_js_to_python(kwargs, _self if isinstance(_self, type) else _self.__class__) + return fn(_self, *args, **kwargs) + return wrapped_init + + +class cached_property(object): + # this caches the result of the function call for fn with no inputs + # use this as a decorator on function methods that you want converted + # into cached properties + result_key = '_results' + + def __init__(self, fn): + self._fn = fn + + def __get__(self, instance, cls=None): + if self.result_key in vars(self): + return vars(self)[self.result_key] + else: + result = self._fn() + setattr(self, self.result_key, result) + return result + + +PRIMITIVE_TYPES = (list, float, int, bool, datetime, date, str, file_type) + +def allows_single_value_input(cls): + """ + This function returns True if the input composed schema model or any + descendant model allows a value only input + This is true for cases where oneOf contains items like: + oneOf: + - float + - NumberWithValidation + - StringEnum + - ArrayModel + - null + TODO: lru_cache this + """ + if ( + issubclass(cls, ModelSimple) or + cls in PRIMITIVE_TYPES + ): + return True + elif issubclass(cls, ModelComposed): + if not cls._composed_schemas['oneOf']: + return False + return any(allows_single_value_input(c) for c in cls._composed_schemas['oneOf']) + return False + +def composed_model_input_classes(cls): + """ + This function returns a list of the possible models that can be accepted as + inputs. + TODO: lru_cache this + """ + if issubclass(cls, ModelSimple) or cls in PRIMITIVE_TYPES: + return [cls] + elif issubclass(cls, ModelNormal): + if cls.discriminator is None: + return [cls] + else: + return get_discriminated_classes(cls) + elif issubclass(cls, ModelComposed): + if not cls._composed_schemas['oneOf']: + return [] + if cls.discriminator is None: + input_classes = [] + for c in cls._composed_schemas['oneOf']: + input_classes.extend(composed_model_input_classes(c)) + return input_classes + else: + return get_discriminated_classes(cls) + return [] + + +class OpenApiModel(object): + """The base class for all OpenAPIModels""" + + def set_attribute(self, name, value): + # this is only used to set properties on self + + path_to_item = [] + if self._path_to_item: + path_to_item.extend(self._path_to_item) + path_to_item.append(name) + + if name in self.openapi_types: + required_types_mixed = self.openapi_types[name] + elif self.additional_properties_type is None: + raise ApiAttributeError( + "{0} has no attribute '{1}'".format( + type(self).__name__, name), + path_to_item + ) + elif self.additional_properties_type is not None: + required_types_mixed = self.additional_properties_type + + if get_simple_class(name) != str: + error_msg = type_error_message( + var_name=name, + var_value=name, + valid_classes=(str,), + key_type=True + ) + raise ApiTypeError( + error_msg, + path_to_item=path_to_item, + valid_classes=(str,), + key_type=True + ) + + if self._check_type: + value = validate_and_convert_types( + value, required_types_mixed, path_to_item, self._spec_property_naming, + self._check_type, configuration=self._configuration) + if (name,) in self.allowed_values: + check_allowed_values( + self.allowed_values, + (name,), + value + ) + if (name,) in self.validations: + check_validations( + self.validations, + (name,), + value, + self._configuration + ) + self.__dict__['_data_store'][name] = value + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __ne__(self, other): + """Returns true if both objects are not equal""" + return not self == other + + def __setattr__(self, attr, value): + """set the value of an attribute using dot notation: `instance.attr = val`""" + self[attr] = value + + def __getattr__(self, attr): + """get the value of an attribute using dot notation: `instance.attr`""" + return self.__getitem__(attr) + + def __copy__(self): + cls = self.__class__ + if self.get("_spec_property_naming", False): + return cls._new_from_openapi_data(**self.__dict__) + else: + return new_cls.__new__(cls, **self.__dict__) + + def __deepcopy__(self, memo): + cls = self.__class__ + + if self.get("_spec_property_naming", False): + new_inst = cls._new_from_openapi_data() + else: + new_inst = cls.__new__(cls) + + for k, v in self.__dict__.items(): + setattr(new_inst, k, deepcopy(v, memo)) + return new_inst + + + def __new__(cls, *args, **kwargs): + # this function uses the discriminator to + # pick a new schema/class to instantiate because a discriminator + # propertyName value was passed in + + if len(args) == 1: + arg = args[0] + if arg is None and is_type_nullable(cls): + # The input data is the 'null' value and the type is nullable. + return None + + if issubclass(cls, ModelComposed) and allows_single_value_input(cls): + model_kwargs = {} + oneof_instance = get_oneof_instance(cls, model_kwargs, kwargs, model_arg=arg) + return oneof_instance + + + visited_composed_classes = kwargs.get('_visited_composed_classes', ()) + if ( + cls.discriminator is None or + cls in visited_composed_classes + ): + # Use case 1: this openapi schema (cls) does not have a discriminator + # Use case 2: we have already visited this class before and are sure that we + # want to instantiate it this time. We have visited this class deserializing + # a payload with a discriminator. During that process we traveled through + # this class but did not make an instance of it. Now we are making an + # instance of a composed class which contains cls in it, so this time make an instance of cls. + # + # Here's an example of use case 2: If Animal has a discriminator + # petType and we pass in "Dog", and the class Dog + # allOf includes Animal, we move through Animal + # once using the discriminator, and pick Dog. + # Then in the composed schema dog Dog, we will make an instance of the + # Animal class (because Dal has allOf: Animal) but this time we won't travel + # through Animal's discriminator because we passed in + # _visited_composed_classes = (Animal,) + + return super(OpenApiModel, cls).__new__(cls) + + # Get the name and value of the discriminator property. + # The discriminator name is obtained from the discriminator meta-data + # and the discriminator value is obtained from the input data. + discr_propertyname_py = list(cls.discriminator.keys())[0] + discr_propertyname_js = cls.attribute_map[discr_propertyname_py] + if discr_propertyname_js in kwargs: + discr_value = kwargs[discr_propertyname_js] + elif discr_propertyname_py in kwargs: + discr_value = kwargs[discr_propertyname_py] + else: + # The input data does not contain the discriminator property. + path_to_item = kwargs.get('_path_to_item', ()) + raise ApiValueError( + "Cannot deserialize input data due to missing discriminator. " + "The discriminator property '%s' is missing at path: %s" % + (discr_propertyname_js, path_to_item) + ) + + # Implementation note: the last argument to get_discriminator_class + # is a list of visited classes. get_discriminator_class may recursively + # call itself and update the list of visited classes, and the initial + # value must be an empty list. Hence not using 'visited_composed_classes' + new_cls = get_discriminator_class( + cls, discr_propertyname_py, discr_value, []) + if new_cls is None: + path_to_item = kwargs.get('_path_to_item', ()) + disc_prop_value = kwargs.get( + discr_propertyname_js, kwargs.get(discr_propertyname_py)) + raise ApiValueError( + "Cannot deserialize input data due to invalid discriminator " + "value. The OpenAPI document has no mapping for discriminator " + "property '%s'='%s' at path: %s" % + (discr_propertyname_js, disc_prop_value, path_to_item) + ) + + if new_cls in visited_composed_classes: + # if we are making an instance of a composed schema Descendent + # which allOf includes Ancestor, then Ancestor contains + # a discriminator that includes Descendent. + # So if we make an instance of Descendent, we have to make an + # instance of Ancestor to hold the allOf properties. + # This code detects that use case and makes the instance of Ancestor + # For example: + # When making an instance of Dog, _visited_composed_classes = (Dog,) + # then we make an instance of Animal to include in dog._composed_instances + # so when we are here, cls is Animal + # cls.discriminator != None + # cls not in _visited_composed_classes + # new_cls = Dog + # but we know we know that we already have Dog + # because it is in visited_composed_classes + # so make Animal here + return super(OpenApiModel, cls).__new__(cls) + + # Build a list containing all oneOf and anyOf descendants. + oneof_anyof_classes = None + if cls._composed_schemas is not None: + oneof_anyof_classes = ( + cls._composed_schemas.get('oneOf', ()) + + cls._composed_schemas.get('anyOf', ())) + oneof_anyof_child = new_cls in oneof_anyof_classes + kwargs['_visited_composed_classes'] = visited_composed_classes + (cls,) + + if cls._composed_schemas.get('allOf') and oneof_anyof_child: + # Validate that we can make self because when we make the + # new_cls it will not include the allOf validations in self + self_inst = super(OpenApiModel, cls).__new__(cls) + self_inst.__init__(*args, **kwargs) + + if kwargs.get("_spec_property_naming", False): + # when true, implies new is from deserialization + new_inst = new_cls._new_from_openapi_data(*args, **kwargs) + else: + new_inst = new_cls.__new__(new_cls, *args, **kwargs) + new_inst.__init__(*args, **kwargs) + + return new_inst + + + @classmethod + @convert_js_args_to_python_args + def _new_from_openapi_data(cls, *args, **kwargs): + # this function uses the discriminator to + # pick a new schema/class to instantiate because a discriminator + # propertyName value was passed in + + if len(args) == 1: + arg = args[0] + if arg is None and is_type_nullable(cls): + # The input data is the 'null' value and the type is nullable. + return None + + if issubclass(cls, ModelComposed) and allows_single_value_input(cls): + model_kwargs = {} + oneof_instance = get_oneof_instance(cls, model_kwargs, kwargs, model_arg=arg) + return oneof_instance + + + visited_composed_classes = kwargs.get('_visited_composed_classes', ()) + if ( + cls.discriminator is None or + cls in visited_composed_classes + ): + # Use case 1: this openapi schema (cls) does not have a discriminator + # Use case 2: we have already visited this class before and are sure that we + # want to instantiate it this time. We have visited this class deserializing + # a payload with a discriminator. During that process we traveled through + # this class but did not make an instance of it. Now we are making an + # instance of a composed class which contains cls in it, so this time make an instance of cls. + # + # Here's an example of use case 2: If Animal has a discriminator + # petType and we pass in "Dog", and the class Dog + # allOf includes Animal, we move through Animal + # once using the discriminator, and pick Dog. + # Then in the composed schema dog Dog, we will make an instance of the + # Animal class (because Dal has allOf: Animal) but this time we won't travel + # through Animal's discriminator because we passed in + # _visited_composed_classes = (Animal,) + + return cls._from_openapi_data(*args, **kwargs) + + # Get the name and value of the discriminator property. + # The discriminator name is obtained from the discriminator meta-data + # and the discriminator value is obtained from the input data. + discr_propertyname_py = list(cls.discriminator.keys())[0] + discr_propertyname_js = cls.attribute_map[discr_propertyname_py] + if discr_propertyname_js in kwargs: + discr_value = kwargs[discr_propertyname_js] + elif discr_propertyname_py in kwargs: + discr_value = kwargs[discr_propertyname_py] + else: + # The input data does not contain the discriminator property. + path_to_item = kwargs.get('_path_to_item', ()) + raise ApiValueError( + "Cannot deserialize input data due to missing discriminator. " + "The discriminator property '%s' is missing at path: %s" % + (discr_propertyname_js, path_to_item) + ) + + # Implementation note: the last argument to get_discriminator_class + # is a list of visited classes. get_discriminator_class may recursively + # call itself and update the list of visited classes, and the initial + # value must be an empty list. Hence not using 'visited_composed_classes' + new_cls = get_discriminator_class( + cls, discr_propertyname_py, discr_value, []) + if new_cls is None: + path_to_item = kwargs.get('_path_to_item', ()) + disc_prop_value = kwargs.get( + discr_propertyname_js, kwargs.get(discr_propertyname_py)) + raise ApiValueError( + "Cannot deserialize input data due to invalid discriminator " + "value. The OpenAPI document has no mapping for discriminator " + "property '%s'='%s' at path: %s" % + (discr_propertyname_js, disc_prop_value, path_to_item) + ) + + if new_cls in visited_composed_classes: + # if we are making an instance of a composed schema Descendent + # which allOf includes Ancestor, then Ancestor contains + # a discriminator that includes Descendent. + # So if we make an instance of Descendent, we have to make an + # instance of Ancestor to hold the allOf properties. + # This code detects that use case and makes the instance of Ancestor + # For example: + # When making an instance of Dog, _visited_composed_classes = (Dog,) + # then we make an instance of Animal to include in dog._composed_instances + # so when we are here, cls is Animal + # cls.discriminator != None + # cls not in _visited_composed_classes + # new_cls = Dog + # but we know we know that we already have Dog + # because it is in visited_composed_classes + # so make Animal here + return cls._from_openapi_data(*args, **kwargs) + + # Build a list containing all oneOf and anyOf descendants. + oneof_anyof_classes = None + if cls._composed_schemas is not None: + oneof_anyof_classes = ( + cls._composed_schemas.get('oneOf', ()) + + cls._composed_schemas.get('anyOf', ())) + oneof_anyof_child = new_cls in oneof_anyof_classes + kwargs['_visited_composed_classes'] = visited_composed_classes + (cls,) + + if cls._composed_schemas.get('allOf') and oneof_anyof_child: + # Validate that we can make self because when we make the + # new_cls it will not include the allOf validations in self + self_inst = cls._from_openapi_data(*args, **kwargs) + + + new_inst = new_cls._new_from_openapi_data(*args, **kwargs) + return new_inst + + +class ModelSimple(OpenApiModel): + """the parent class of models whose type != object in their + swagger/openapi""" + + def __setitem__(self, name, value): + """set the value of an attribute using square-bracket notation: `instance[attr] = val`""" + if name in self.required_properties: + self.__dict__[name] = value + return + + self.set_attribute(name, value) + + def get(self, name, default=None): + """returns the value of an attribute or some default value if the attribute was not set""" + if name in self.required_properties: + return self.__dict__[name] + + return self.__dict__['_data_store'].get(name, default) + + def __getitem__(self, name): + """get the value of an attribute using square-bracket notation: `instance[attr]`""" + if name in self: + return self.get(name) + + raise ApiAttributeError( + "{0} has no attribute '{1}'".format( + type(self).__name__, name), + [e for e in [self._path_to_item, name] if e] + ) + + def __contains__(self, name): + """used by `in` operator to check if an attribute value was set in an instance: `'attr' in instance`""" + if name in self.required_properties: + return name in self.__dict__ + + return name in self.__dict__['_data_store'] + + def to_str(self): + """Returns the string representation of the model""" + return str(self.value) + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, self.__class__): + return False + + this_val = self._data_store['value'] + that_val = other._data_store['value'] + types = set() + types.add(this_val.__class__) + types.add(that_val.__class__) + vals_equal = this_val == that_val + return vals_equal + + +class ModelNormal(OpenApiModel): + """the parent class of models whose type == object in their + swagger/openapi""" + + def __setitem__(self, name, value): + """set the value of an attribute using square-bracket notation: `instance[attr] = val`""" + if name in self.required_properties: + self.__dict__[name] = value + return + + self.set_attribute(name, value) + + def get(self, name, default=None): + """returns the value of an attribute or some default value if the attribute was not set""" + if name in self.required_properties: + return self.__dict__[name] + + return self.__dict__['_data_store'].get(name, default) + + def __getitem__(self, name): + """get the value of an attribute using square-bracket notation: `instance[attr]`""" + if name in self: + return self.get(name) + + raise ApiAttributeError( + "{0} has no attribute '{1}'".format( + type(self).__name__, name), + [e for e in [self._path_to_item, name] if e] + ) + + def __contains__(self, name): + """used by `in` operator to check if an attribute value was set in an instance: `'attr' in instance`""" + if name in self.required_properties: + return name in self.__dict__ + + return name in self.__dict__['_data_store'] + + def to_dict(self): + """Returns the model properties as a dict""" + return model_to_dict(self, serialize=False) + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, self.__class__): + return False + + if not set(self._data_store.keys()) == set(other._data_store.keys()): + return False + for _var_name, this_val in self._data_store.items(): + that_val = other._data_store[_var_name] + types = set() + types.add(this_val.__class__) + types.add(that_val.__class__) + vals_equal = this_val == that_val + if not vals_equal: + return False + return True + + +class ModelComposed(OpenApiModel): + """the parent class of models whose type == object in their + swagger/openapi and have oneOf/allOf/anyOf + + When one sets a property we use var_name_to_model_instances to store the value in + the correct class instances + run any type checking + validation code. + When one gets a property we use var_name_to_model_instances to get the value + from the correct class instances. + This allows multiple composed schemas to contain the same property with additive + constraints on the value. + + _composed_schemas (dict) stores the anyOf/allOf/oneOf classes + key (str): allOf/oneOf/anyOf + value (list): the classes in the XOf definition. + Note: none_type can be included when the openapi document version >= 3.1.0 + _composed_instances (list): stores a list of instances of the composed schemas + defined in _composed_schemas. When properties are accessed in the self instance, + they are returned from the self._data_store or the data stores in the instances + in self._composed_schemas + _var_name_to_model_instances (dict): maps between a variable name on self and + the composed instances (self included) which contain that data + key (str): property name + value (list): list of class instances, self or instances in _composed_instances + which contain the value that the key is referring to. + """ + + def __setitem__(self, name, value): + """set the value of an attribute using square-bracket notation: `instance[attr] = val`""" + if name in self.required_properties: + self.__dict__[name] = value + return + + """ + Use cases: + 1. additional_properties_type is None (additionalProperties == False in spec) + Check for property presence in self.openapi_types + if not present then throw an error + if present set in self, set attribute + always set on composed schemas + 2. additional_properties_type exists + set attribute on self + always set on composed schemas + """ + if self.additional_properties_type is None: + """ + For an attribute to exist on a composed schema it must: + - fulfill schema_requirements in the self composed schema not considering oneOf/anyOf/allOf schemas AND + - fulfill schema_requirements in each oneOf/anyOf/allOf schemas + + schema_requirements: + For an attribute to exist on a schema it must: + - be present in properties at the schema OR + - have additionalProperties unset (defaults additionalProperties = any type) OR + - have additionalProperties set + """ + if name not in self.openapi_types: + raise ApiAttributeError( + "{0} has no attribute '{1}'".format( + type(self).__name__, name), + [e for e in [self._path_to_item, name] if e] + ) + # attribute must be set on self and composed instances + self.set_attribute(name, value) + for model_instance in self._composed_instances: + setattr(model_instance, name, value) + if name not in self._var_name_to_model_instances: + # we assigned an additional property + self.__dict__['_var_name_to_model_instances'][name] = self._composed_instances + [self] + return None + + __unset_attribute_value__ = object() + + def get(self, name, default=None): + """returns the value of an attribute or some default value if the attribute was not set""" + if name in self.required_properties: + return self.__dict__[name] + + # get the attribute from the correct instance + model_instances = self._var_name_to_model_instances.get(name) + values = [] + # A composed model stores self and child (oneof/anyOf/allOf) models under + # self._var_name_to_model_instances. + # Any property must exist in self and all model instances + # The value stored in all model instances must be the same + if model_instances: + for model_instance in model_instances: + if name in model_instance._data_store: + v = model_instance._data_store[name] + if v not in values: + values.append(v) + len_values = len(values) + if len_values == 0: + return default + elif len_values == 1: + return values[0] + elif len_values > 1: + raise ApiValueError( + "Values stored for property {0} in {1} differ when looking " + "at self and self's composed instances. All values must be " + "the same".format(name, type(self).__name__), + [e for e in [self._path_to_item, name] if e] + ) + + def __getitem__(self, name): + """get the value of an attribute using square-bracket notation: `instance[attr]`""" + value = self.get(name, self.__unset_attribute_value__) + if value is self.__unset_attribute_value__: + raise ApiAttributeError( + "{0} has no attribute '{1}'".format( + type(self).__name__, name), + [e for e in [self._path_to_item, name] if e] + ) + return value + + def __contains__(self, name): + """used by `in` operator to check if an attribute value was set in an instance: `'attr' in instance`""" + + if name in self.required_properties: + return name in self.__dict__ + + model_instances = self._var_name_to_model_instances.get( + name, self._additional_properties_model_instances) + + if model_instances: + for model_instance in model_instances: + if name in model_instance._data_store: + return True + + return False + + def to_dict(self): + """Returns the model properties as a dict""" + return model_to_dict(self, serialize=False) + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, self.__class__): + return False + + if not set(self._data_store.keys()) == set(other._data_store.keys()): + return False + for _var_name, this_val in self._data_store.items(): + that_val = other._data_store[_var_name] + types = set() + types.add(this_val.__class__) + types.add(that_val.__class__) + vals_equal = this_val == that_val + if not vals_equal: + return False + return True + + +COERCION_INDEX_BY_TYPE = { + ModelComposed: 0, + ModelNormal: 1, + ModelSimple: 2, + none_type: 3, # The type of 'None'. + list: 4, + dict: 5, + float: 6, + int: 7, + bool: 8, + datetime: 9, + date: 10, + str: 11, + file_type: 12, # 'file_type' is an alias for the built-in 'file' or 'io.IOBase' type. +} + +# these are used to limit what type conversions we try to do +# when we have a valid type already and we want to try converting +# to another type +UPCONVERSION_TYPE_PAIRS = ( + (str, datetime), + (str, date), + (int, float), # A float may be serialized as an integer, e.g. '3' is a valid serialized float. + (list, ModelComposed), + (dict, ModelComposed), + (str, ModelComposed), + (int, ModelComposed), + (float, ModelComposed), + (list, ModelComposed), + (list, ModelNormal), + (dict, ModelNormal), + (str, ModelSimple), + (int, ModelSimple), + (float, ModelSimple), + (list, ModelSimple), +) + +COERCIBLE_TYPE_PAIRS = { + False: ( # client instantiation of a model with client data + # (dict, ModelComposed), + # (list, ModelComposed), + # (dict, ModelNormal), + # (list, ModelNormal), + # (str, ModelSimple), + # (int, ModelSimple), + # (float, ModelSimple), + # (list, ModelSimple), + # (str, int), + # (str, float), + # (str, datetime), + # (str, date), + # (int, str), + # (float, str), + ), + True: ( # server -> client data + (dict, ModelComposed), + (list, ModelComposed), + (dict, ModelNormal), + (list, ModelNormal), + (str, ModelSimple), + (int, ModelSimple), + (float, ModelSimple), + (list, ModelSimple), + # (str, int), + # (str, float), + (str, datetime), + (str, date), + # (int, str), + # (float, str), + (str, file_type) + ), +} + + +def get_simple_class(input_value): + """Returns an input_value's simple class that we will use for type checking + Python2: + float and int will return int, where int is the python3 int backport + str and unicode will return str, where str is the python3 str backport + Note: float and int ARE both instances of int backport + Note: str_py2 and unicode_py2 are NOT both instances of str backport + + Args: + input_value (class/class_instance): the item for which we will return + the simple class + """ + if isinstance(input_value, type): + # input_value is a class + return input_value + elif isinstance(input_value, tuple): + return tuple + elif isinstance(input_value, list): + return list + elif isinstance(input_value, dict): + return dict + elif isinstance(input_value, none_type): + return none_type + elif isinstance(input_value, file_type): + return file_type + elif isinstance(input_value, bool): + # this must be higher than the int check because + # isinstance(True, int) == True + return bool + elif isinstance(input_value, int): + return int + elif isinstance(input_value, datetime): + # this must be higher than the date check because + # isinstance(datetime_instance, date) == True + return datetime + elif isinstance(input_value, date): + return date + elif isinstance(input_value, str): + return str + return type(input_value) + + +def check_allowed_values(allowed_values, input_variable_path, input_values): + """Raises an exception if the input_values are not allowed + + Args: + allowed_values (dict): the allowed_values dict + input_variable_path (tuple): the path to the input variable + input_values (list/str/int/float/date/datetime): the values that we + are checking to see if they are in allowed_values + """ + these_allowed_values = list(allowed_values[input_variable_path].values()) + if (isinstance(input_values, list) + and not set(input_values).issubset( + set(these_allowed_values))): + invalid_values = ", ".join( + map(str, set(input_values) - set(these_allowed_values))), + raise ApiValueError( + "Invalid values for `%s` [%s], must be a subset of [%s]" % + ( + input_variable_path[0], + invalid_values, + ", ".join(map(str, these_allowed_values)) + ) + ) + elif (isinstance(input_values, dict) + and not set( + input_values.keys()).issubset(set(these_allowed_values))): + invalid_values = ", ".join( + map(str, set(input_values.keys()) - set(these_allowed_values))) + raise ApiValueError( + "Invalid keys in `%s` [%s], must be a subset of [%s]" % + ( + input_variable_path[0], + invalid_values, + ", ".join(map(str, these_allowed_values)) + ) + ) + elif (not isinstance(input_values, (list, dict)) + and input_values not in these_allowed_values): + raise ApiValueError( + "Invalid value for `%s` (%s), must be one of %s" % + ( + input_variable_path[0], + input_values, + these_allowed_values + ) + ) + + +def is_json_validation_enabled(schema_keyword, configuration=None): + """Returns true if JSON schema validation is enabled for the specified + validation keyword. This can be used to skip JSON schema structural validation + as requested in the configuration. + + Args: + schema_keyword (string): the name of a JSON schema validation keyword. + configuration (Configuration): the configuration class. + """ + + return (configuration is None or + not hasattr(configuration, '_disabled_client_side_validations') or + schema_keyword not in configuration._disabled_client_side_validations) + + +def check_validations( + validations, input_variable_path, input_values, + configuration=None): + """Raises an exception if the input_values are invalid + + Args: + validations (dict): the validation dictionary. + input_variable_path (tuple): the path to the input variable. + input_values (list/str/int/float/date/datetime): the values that we + are checking. + configuration (Configuration): the configuration class. + """ + + if input_values is None: + return + + current_validations = validations[input_variable_path] + if (is_json_validation_enabled('multipleOf', configuration) and + 'multiple_of' in current_validations and + isinstance(input_values, (int, float)) and + not (float(input_values) / current_validations['multiple_of']).is_integer()): + # Note 'multipleOf' will be as good as the floating point arithmetic. + raise ApiValueError( + "Invalid value for `%s`, value must be a multiple of " + "`%s`" % ( + input_variable_path[0], + current_validations['multiple_of'] + ) + ) + + if (is_json_validation_enabled('maxLength', configuration) and + 'max_length' in current_validations and + len(input_values) > current_validations['max_length']): + raise ApiValueError( + "Invalid value for `%s`, length must be less than or equal to " + "`%s`" % ( + input_variable_path[0], + current_validations['max_length'] + ) + ) + + if (is_json_validation_enabled('minLength', configuration) and + 'min_length' in current_validations and + len(input_values) < current_validations['min_length']): + raise ApiValueError( + "Invalid value for `%s`, length must be greater than or equal to " + "`%s`" % ( + input_variable_path[0], + current_validations['min_length'] + ) + ) + + if (is_json_validation_enabled('maxItems', configuration) and + 'max_items' in current_validations and + len(input_values) > current_validations['max_items']): + raise ApiValueError( + "Invalid value for `%s`, number of items must be less than or " + "equal to `%s`" % ( + input_variable_path[0], + current_validations['max_items'] + ) + ) + + if (is_json_validation_enabled('minItems', configuration) and + 'min_items' in current_validations and + len(input_values) < current_validations['min_items']): + raise ValueError( + "Invalid value for `%s`, number of items must be greater than or " + "equal to `%s`" % ( + input_variable_path[0], + current_validations['min_items'] + ) + ) + + items = ('exclusive_maximum', 'inclusive_maximum', 'exclusive_minimum', + 'inclusive_minimum') + if (any(item in current_validations for item in items)): + if isinstance(input_values, list): + max_val = max(input_values) + min_val = min(input_values) + elif isinstance(input_values, dict): + max_val = max(input_values.values()) + min_val = min(input_values.values()) + else: + max_val = input_values + min_val = input_values + + if (is_json_validation_enabled('exclusiveMaximum', configuration) and + 'exclusive_maximum' in current_validations and + max_val >= current_validations['exclusive_maximum']): + raise ApiValueError( + "Invalid value for `%s`, must be a value less than `%s`" % ( + input_variable_path[0], + current_validations['exclusive_maximum'] + ) + ) + + if (is_json_validation_enabled('maximum', configuration) and + 'inclusive_maximum' in current_validations and + max_val > current_validations['inclusive_maximum']): + raise ApiValueError( + "Invalid value for `%s`, must be a value less than or equal to " + "`%s`" % ( + input_variable_path[0], + current_validations['inclusive_maximum'] + ) + ) + + if (is_json_validation_enabled('exclusiveMinimum', configuration) and + 'exclusive_minimum' in current_validations and + min_val <= current_validations['exclusive_minimum']): + raise ApiValueError( + "Invalid value for `%s`, must be a value greater than `%s`" % + ( + input_variable_path[0], + current_validations['exclusive_maximum'] + ) + ) + + if (is_json_validation_enabled('minimum', configuration) and + 'inclusive_minimum' in current_validations and + min_val < current_validations['inclusive_minimum']): + raise ApiValueError( + "Invalid value for `%s`, must be a value greater than or equal " + "to `%s`" % ( + input_variable_path[0], + current_validations['inclusive_minimum'] + ) + ) + flags = current_validations.get('regex', {}).get('flags', 0) + if (is_json_validation_enabled('pattern', configuration) and + 'regex' in current_validations and + not re.search(current_validations['regex']['pattern'], + input_values, flags=flags)): + err_msg = r"Invalid value for `%s`, must match regular expression `%s`" % ( + input_variable_path[0], + current_validations['regex']['pattern'] + ) + if flags != 0: + # Don't print the regex flags if the flags are not + # specified in the OAS document. + err_msg = r"%s with flags=`%s`" % (err_msg, flags) + raise ApiValueError(err_msg) + + +def order_response_types(required_types): + """Returns the required types sorted in coercion order + + Args: + required_types (list/tuple): collection of classes or instance of + list or dict with class information inside it. + + Returns: + (list): coercion order sorted collection of classes or instance + of list or dict with class information inside it. + """ + + def index_getter(class_or_instance): + if isinstance(class_or_instance, list): + return COERCION_INDEX_BY_TYPE[list] + elif isinstance(class_or_instance, dict): + return COERCION_INDEX_BY_TYPE[dict] + elif (inspect.isclass(class_or_instance) + and issubclass(class_or_instance, ModelComposed)): + return COERCION_INDEX_BY_TYPE[ModelComposed] + elif (inspect.isclass(class_or_instance) + and issubclass(class_or_instance, ModelNormal)): + return COERCION_INDEX_BY_TYPE[ModelNormal] + elif (inspect.isclass(class_or_instance) + and issubclass(class_or_instance, ModelSimple)): + return COERCION_INDEX_BY_TYPE[ModelSimple] + elif class_or_instance in COERCION_INDEX_BY_TYPE: + return COERCION_INDEX_BY_TYPE[class_or_instance] + raise ApiValueError("Unsupported type: %s" % class_or_instance) + + sorted_types = sorted( + required_types, + key=lambda class_or_instance: index_getter(class_or_instance) + ) + return sorted_types + + +def remove_uncoercible(required_types_classes, current_item, spec_property_naming, + must_convert=True): + """Only keeps the type conversions that are possible + + Args: + required_types_classes (tuple): tuple of classes that are required + these should be ordered by COERCION_INDEX_BY_TYPE + spec_property_naming (bool): True if the variable names in the input + data are serialized names as specified in the OpenAPI document. + False if the variables names in the input data are python + variable names in PEP-8 snake case. + current_item (any): the current item (input data) to be converted + + Keyword Args: + must_convert (bool): if True the item to convert is of the wrong + type and we want a big list of coercibles + if False, we want a limited list of coercibles + + Returns: + (list): the remaining coercible required types, classes only + """ + current_type_simple = get_simple_class(current_item) + + results_classes = [] + for required_type_class in required_types_classes: + # convert our models to OpenApiModel + required_type_class_simplified = required_type_class + if isinstance(required_type_class_simplified, type): + if issubclass(required_type_class_simplified, ModelComposed): + required_type_class_simplified = ModelComposed + elif issubclass(required_type_class_simplified, ModelNormal): + required_type_class_simplified = ModelNormal + elif issubclass(required_type_class_simplified, ModelSimple): + required_type_class_simplified = ModelSimple + + if required_type_class_simplified == current_type_simple: + # don't consider converting to one's own class + continue + + class_pair = (current_type_simple, required_type_class_simplified) + if must_convert and class_pair in COERCIBLE_TYPE_PAIRS[spec_property_naming]: + results_classes.append(required_type_class) + elif class_pair in UPCONVERSION_TYPE_PAIRS: + results_classes.append(required_type_class) + return results_classes + +def get_discriminated_classes(cls): + """ + Returns all the classes that a discriminator converts to + TODO: lru_cache this + """ + possible_classes = [] + key = list(cls.discriminator.keys())[0] + if is_type_nullable(cls): + possible_classes.append(cls) + for discr_cls in cls.discriminator[key].values(): + if hasattr(discr_cls, 'discriminator') and discr_cls.discriminator is not None: + possible_classes.extend(get_discriminated_classes(discr_cls)) + else: + possible_classes.append(discr_cls) + return possible_classes + + +def get_possible_classes(cls, from_server_context): + # TODO: lru_cache this + possible_classes = [cls] + if from_server_context: + return possible_classes + if hasattr(cls, 'discriminator') and cls.discriminator is not None: + possible_classes = [] + possible_classes.extend(get_discriminated_classes(cls)) + elif issubclass(cls, ModelComposed): + possible_classes.extend(composed_model_input_classes(cls)) + return possible_classes + + +def get_required_type_classes(required_types_mixed, spec_property_naming): + """Converts the tuple required_types into a tuple and a dict described + below + + Args: + required_types_mixed (tuple/list): will contain either classes or + instance of list or dict + spec_property_naming (bool): if True these values came from the + server, and we use the data types in our endpoints. + If False, we are client side and we need to include + oneOf and discriminator classes inside the data types in our endpoints + + Returns: + (valid_classes, dict_valid_class_to_child_types_mixed): + valid_classes (tuple): the valid classes that the current item + should be + dict_valid_class_to_child_types_mixed (dict): + valid_class (class): this is the key + child_types_mixed (list/dict/tuple): describes the valid child + types + """ + valid_classes = [] + child_req_types_by_current_type = {} + for required_type in required_types_mixed: + if isinstance(required_type, list): + valid_classes.append(list) + child_req_types_by_current_type[list] = required_type + elif isinstance(required_type, tuple): + valid_classes.append(tuple) + child_req_types_by_current_type[tuple] = required_type + elif isinstance(required_type, dict): + valid_classes.append(dict) + child_req_types_by_current_type[dict] = required_type[str] + else: + valid_classes.extend(get_possible_classes(required_type, spec_property_naming)) + return tuple(valid_classes), child_req_types_by_current_type + + +def change_keys_js_to_python(input_dict, model_class): + """ + Converts from javascript_key keys in the input_dict to python_keys in + the output dict using the mapping in model_class. + If the input_dict contains a key which does not declared in the model_class, + the key is added to the output dict as is. The assumption is the model_class + may have undeclared properties (additionalProperties attribute in the OAS + document). + """ + + if getattr(model_class, 'attribute_map', None) is None: + return input_dict + output_dict = {} + reversed_attr_map = {value: key for key, value in + model_class.attribute_map.items()} + for javascript_key, value in input_dict.items(): + python_key = reversed_attr_map.get(javascript_key) + if python_key is None: + # if the key is unknown, it is in error or it is an + # additionalProperties variable + python_key = javascript_key + output_dict[python_key] = value + return output_dict + + +def get_type_error(var_value, path_to_item, valid_classes, key_type=False): + error_msg = type_error_message( + var_name=path_to_item[-1], + var_value=var_value, + valid_classes=valid_classes, + key_type=key_type + ) + return ApiTypeError( + error_msg, + path_to_item=path_to_item, + valid_classes=valid_classes, + key_type=key_type + ) + + +def deserialize_primitive(data, klass, path_to_item): + """Deserializes string to primitive type. + + :param data: str/int/float + :param klass: str/class the class to convert to + + :return: int, float, str, bool, date, datetime + """ + additional_message = "" + try: + if klass in {datetime, date}: + additional_message = ( + "If you need your parameter to have a fallback " + "string value, please set its type as `type: {}` in your " + "spec. That allows the value to be any type. " + ) + if klass == datetime: + if len(data) < 8: + raise ValueError("This is not a datetime") + # The string should be in iso8601 datetime format. + parsed_datetime = parse(data) + date_only = ( + parsed_datetime.hour == 0 and + parsed_datetime.minute == 0 and + parsed_datetime.second == 0 and + parsed_datetime.tzinfo is None and + 8 <= len(data) <= 10 + ) + if date_only: + raise ValueError("This is a date, not a datetime") + return parsed_datetime + elif klass == date: + if len(data) < 8: + raise ValueError("This is not a date") + return parse(data).date() + else: + converted_value = klass(data) + if isinstance(data, str) and klass == float: + if str(converted_value) != data: + # '7' -> 7.0 -> '7.0' != '7' + raise ValueError('This is not a float') + return converted_value + except (OverflowError, ValueError) as ex: + # parse can raise OverflowError + raise ApiValueError( + "{0}Failed to parse {1} as {2}".format( + additional_message, repr(data), klass.__name__ + ), + path_to_item=path_to_item + ) from ex + + +def get_discriminator_class(model_class, + discr_name, + discr_value, cls_visited): + """Returns the child class specified by the discriminator. + + Args: + model_class (OpenApiModel): the model class. + discr_name (string): the name of the discriminator property. + discr_value (any): the discriminator value. + cls_visited (list): list of model classes that have been visited. + Used to determine the discriminator class without + visiting circular references indefinitely. + + Returns: + used_model_class (class/None): the chosen child class that will be used + to deserialize the data, for example dog.Dog. + If a class is not found, None is returned. + """ + + if model_class in cls_visited: + # The class has already been visited and no suitable class was found. + return None + cls_visited.append(model_class) + used_model_class = None + if discr_name in model_class.discriminator: + class_name_to_discr_class = model_class.discriminator[discr_name] + used_model_class = class_name_to_discr_class.get(discr_value) + if used_model_class is None: + # We didn't find a discriminated class in class_name_to_discr_class. + # So look in the ancestor or descendant discriminators + # The discriminator mapping may exist in a descendant (anyOf, oneOf) + # or ancestor (allOf). + # Ancestor example: in the GrandparentAnimal -> ParentPet -> ChildCat + # hierarchy, the discriminator mappings may be defined at any level + # in the hierarchy. + # Descendant example: mammal -> whale/zebra/Pig -> BasquePig/DanishPig + # if we try to make BasquePig from mammal, we need to travel through + # the oneOf descendant discriminators to find BasquePig + descendant_classes = model_class._composed_schemas.get('oneOf', ()) + \ + model_class._composed_schemas.get('anyOf', ()) + ancestor_classes = model_class._composed_schemas.get('allOf', ()) + possible_classes = descendant_classes + ancestor_classes + for cls in possible_classes: + # Check if the schema has inherited discriminators. + if hasattr(cls, 'discriminator') and cls.discriminator is not None: + used_model_class = get_discriminator_class( + cls, discr_name, discr_value, cls_visited) + if used_model_class is not None: + return used_model_class + return used_model_class + + +def deserialize_model(model_data, model_class, path_to_item, check_type, + configuration, spec_property_naming): + """Deserializes model_data to model instance. + + Args: + model_data (int/str/float/bool/none_type/list/dict): data to instantiate the model + model_class (OpenApiModel): the model class + path_to_item (list): path to the model in the received data + check_type (bool): whether to check the data tupe for the values in + the model + configuration (Configuration): the instance to use to convert files + spec_property_naming (bool): True if the variable names in the input + data are serialized names as specified in the OpenAPI document. + False if the variables names in the input data are python + variable names in PEP-8 snake case. + + Returns: + model instance + + Raise: + ApiTypeError + ApiValueError + ApiKeyError + """ + + kw_args = dict(_check_type=check_type, + _path_to_item=path_to_item, + _configuration=configuration, + _spec_property_naming=spec_property_naming) + + if issubclass(model_class, ModelSimple): + return model_class._new_from_openapi_data(model_data, **kw_args) + elif isinstance(model_data, list): + return model_class._new_from_openapi_data(*model_data, **kw_args) + if isinstance(model_data, dict): + kw_args.update(model_data) + return model_class._new_from_openapi_data(**kw_args) + elif isinstance(model_data, PRIMITIVE_TYPES): + return model_class._new_from_openapi_data(model_data, **kw_args) + + +def deserialize_file(response_data, configuration, content_disposition=None): + """Deserializes body to file + + Saves response body into a file in a temporary folder, + using the filename from the `Content-Disposition` header if provided. + + Args: + param response_data (str): the file data to write + configuration (Configuration): the instance to use to convert files + + Keyword Args: + content_disposition (str): the value of the Content-Disposition + header + + Returns: + (file_type): the deserialized file which is open + The user is responsible for closing and reading the file + """ + fd, path = tempfile.mkstemp(dir=configuration.temp_folder_path) + os.close(fd) + os.remove(path) + + if content_disposition: + filename = re.search(r'filename=[\'"]?([^\'"\s]+)[\'"]?', + content_disposition).group(1) + path = os.path.join(os.path.dirname(path), filename) + + with open(path, "wb") as f: + if isinstance(response_data, str): + # change str to bytes so we can write it + response_data = response_data.encode('utf-8') + f.write(response_data) + + f = open(path, "rb") + return f + + +def attempt_convert_item(input_value, valid_classes, path_to_item, + configuration, spec_property_naming, key_type=False, + must_convert=False, check_type=True): + """ + Args: + input_value (any): the data to convert + valid_classes (any): the classes that are valid + path_to_item (list): the path to the item to convert + configuration (Configuration): the instance to use to convert files + spec_property_naming (bool): True if the variable names in the input + data are serialized names as specified in the OpenAPI document. + False if the variables names in the input data are python + variable names in PEP-8 snake case. + key_type (bool): if True we need to convert a key type (not supported) + must_convert (bool): if True we must convert + check_type (bool): if True we check the type or the returned data in + ModelComposed/ModelNormal/ModelSimple instances + + Returns: + instance (any) the fixed item + + Raises: + ApiTypeError + ApiValueError + ApiKeyError + """ + valid_classes_ordered = order_response_types(valid_classes) + valid_classes_coercible = remove_uncoercible( + valid_classes_ordered, input_value, spec_property_naming) + if not valid_classes_coercible or key_type: + # we do not handle keytype errors, json will take care + # of this for us + if configuration is None or not configuration.discard_unknown_keys: + raise get_type_error(input_value, path_to_item, valid_classes, + key_type=key_type) + for valid_class in valid_classes_coercible: + try: + if issubclass(valid_class, OpenApiModel): + return deserialize_model(input_value, valid_class, + path_to_item, check_type, + configuration, spec_property_naming) + elif valid_class == file_type: + return deserialize_file(input_value, configuration) + return deserialize_primitive(input_value, valid_class, + path_to_item) + except (ApiTypeError, ApiValueError, ApiKeyError) as conversion_exc: + if must_convert: + raise conversion_exc + # if we have conversion errors when must_convert == False + # we ignore the exception and move on to the next class + continue + # we were unable to convert, must_convert == False + return input_value + + +def is_type_nullable(input_type): + """ + Returns true if None is an allowed value for the specified input_type. + + A type is nullable if at least one of the following conditions is true: + 1. The OAS 'nullable' attribute has been specified, + 1. The type is the 'null' type, + 1. The type is a anyOf/oneOf composed schema, and a child schema is + the 'null' type. + Args: + input_type (type): the class of the input_value that we are + checking + Returns: + bool + """ + if input_type is none_type: + return True + if issubclass(input_type, OpenApiModel) and input_type._nullable: + return True + if issubclass(input_type, ModelComposed): + # If oneOf/anyOf, check if the 'null' type is one of the allowed types. + for t in input_type._composed_schemas.get('oneOf', ()): + if is_type_nullable(t): return True + for t in input_type._composed_schemas.get('anyOf', ()): + if is_type_nullable(t): return True + return False + + +def is_valid_type(input_class_simple, valid_classes): + """ + Args: + input_class_simple (class): the class of the input_value that we are + checking + valid_classes (tuple): the valid classes that the current item + should be + Returns: + bool + """ + if issubclass(input_class_simple, OpenApiModel) and \ + valid_classes == (bool, date, datetime, dict, float, int, list, str, none_type,): + return True + valid_type = input_class_simple in valid_classes + if not valid_type and ( + issubclass(input_class_simple, OpenApiModel) or + input_class_simple is none_type): + for valid_class in valid_classes: + if input_class_simple is none_type and is_type_nullable(valid_class): + # Schema is oneOf/anyOf and the 'null' type is one of the allowed types. + return True + if not (issubclass(valid_class, OpenApiModel) and valid_class.discriminator): + continue + discr_propertyname_py = list(valid_class.discriminator.keys())[0] + discriminator_classes = ( + valid_class.discriminator[discr_propertyname_py].values() + ) + valid_type = is_valid_type(input_class_simple, discriminator_classes) + if valid_type: + return True + return valid_type + + +def validate_and_convert_types(input_value, required_types_mixed, path_to_item, + spec_property_naming, _check_type, configuration=None): + """Raises a TypeError is there is a problem, otherwise returns value + + Args: + input_value (any): the data to validate/convert + required_types_mixed (list/dict/tuple): A list of + valid classes, or a list tuples of valid classes, or a dict where + the value is a tuple of value classes + path_to_item: (list) the path to the data being validated + this stores a list of keys or indices to get to the data being + validated + spec_property_naming (bool): True if the variable names in the input + data are serialized names as specified in the OpenAPI document. + False if the variables names in the input data are python + variable names in PEP-8 snake case. + _check_type: (boolean) if true, type will be checked and conversion + will be attempted. + configuration: (Configuration): the configuration class to use + when converting file_type items. + If passed, conversion will be attempted when possible + If not passed, no conversions will be attempted and + exceptions will be raised + + Returns: + the correctly typed value + + Raises: + ApiTypeError + """ + results = get_required_type_classes(required_types_mixed, spec_property_naming) + valid_classes, child_req_types_by_current_type = results + + input_class_simple = get_simple_class(input_value) + valid_type = is_valid_type(input_class_simple, valid_classes) + if not valid_type: + if configuration: + # if input_value is not valid_type try to convert it + converted_instance = attempt_convert_item( + input_value, + valid_classes, + path_to_item, + configuration, + spec_property_naming, + key_type=False, + must_convert=True, + check_type=_check_type + ) + return converted_instance + else: + raise get_type_error(input_value, path_to_item, valid_classes, + key_type=False) + + # input_value's type is in valid_classes + if len(valid_classes) > 1 and configuration: + # there are valid classes which are not the current class + valid_classes_coercible = remove_uncoercible( + valid_classes, input_value, spec_property_naming, must_convert=False) + if valid_classes_coercible: + converted_instance = attempt_convert_item( + input_value, + valid_classes_coercible, + path_to_item, + configuration, + spec_property_naming, + key_type=False, + must_convert=False, + check_type=_check_type + ) + return converted_instance + + if child_req_types_by_current_type == {}: + # all types are of the required types and there are no more inner + # variables left to look at + return input_value + inner_required_types = child_req_types_by_current_type.get( + type(input_value) + ) + if inner_required_types is None: + # for this type, there are not more inner variables left to look at + return input_value + if isinstance(input_value, list): + if input_value == []: + # allow an empty list + return input_value + for index, inner_value in enumerate(input_value): + inner_path = list(path_to_item) + inner_path.append(index) + input_value[index] = validate_and_convert_types( + inner_value, + inner_required_types, + inner_path, + spec_property_naming, + _check_type, + configuration=configuration + ) + elif isinstance(input_value, dict): + if input_value == {}: + # allow an empty dict + return input_value + for inner_key, inner_val in input_value.items(): + inner_path = list(path_to_item) + inner_path.append(inner_key) + if get_simple_class(inner_key) != str: + raise get_type_error(inner_key, inner_path, valid_classes, + key_type=True) + input_value[inner_key] = validate_and_convert_types( + inner_val, + inner_required_types, + inner_path, + spec_property_naming, + _check_type, + configuration=configuration + ) + return input_value + + +def model_to_dict(model_instance, serialize=True): + """Returns the model properties as a dict + + Args: + model_instance (one of your model instances): the model instance that + will be converted to a dict. + + Keyword Args: + serialize (bool): if True, the keys in the dict will be values from + attribute_map + """ + result = {} + extract_item = lambda item: (item[0], model_to_dict(item[1], serialize=serialize)) if hasattr(item[1], '_data_store') else item + + model_instances = [model_instance] + if model_instance._composed_schemas: + model_instances.extend(model_instance._composed_instances) + seen_json_attribute_names = set() + used_fallback_python_attribute_names = set() + py_to_json_map = {} + for model_instance in model_instances: + for attr, value in model_instance._data_store.items(): + if serialize: + # we use get here because additional property key names do not + # exist in attribute_map + try: + attr = model_instance.attribute_map[attr] + py_to_json_map.update(model_instance.attribute_map) + seen_json_attribute_names.add(attr) + except KeyError: + used_fallback_python_attribute_names.add(attr) + if isinstance(value, list): + if not value: + # empty list or None + result[attr] = value + else: + res = [] + for v in value: + if isinstance(v, PRIMITIVE_TYPES) or v is None: + res.append(v) + elif isinstance(v, ModelSimple): + res.append(v.value) + elif isinstance(v, dict): + res.append(dict(map( + extract_item, + v.items() + ))) + else: + res.append(model_to_dict(v, serialize=serialize)) + result[attr] = res + elif isinstance(value, dict): + result[attr] = dict(map( + extract_item, + value.items() + )) + elif isinstance(value, ModelSimple): + result[attr] = value.value + elif hasattr(value, '_data_store'): + result[attr] = model_to_dict(value, serialize=serialize) + else: + result[attr] = value + if serialize: + for python_key in used_fallback_python_attribute_names: + json_key = py_to_json_map.get(python_key) + if json_key is None: + continue + if python_key == json_key: + continue + json_key_assigned_no_need_for_python_key = json_key in seen_json_attribute_names + if json_key_assigned_no_need_for_python_key: + del result[python_key] + + return result + + +def type_error_message(var_value=None, var_name=None, valid_classes=None, + key_type=None): + """ + Keyword Args: + var_value (any): the variable which has the type_error + var_name (str): the name of the variable which has the typ error + valid_classes (tuple): the accepted classes for current_item's + value + key_type (bool): False if our value is a value in a dict + True if it is a key in a dict + False if our item is an item in a list + """ + key_or_value = 'value' + if key_type: + key_or_value = 'key' + valid_classes_phrase = get_valid_classes_phrase(valid_classes) + msg = ( + "Invalid type for variable '{0}'. Required {1} type {2} and " + "passed type was {3}".format( + var_name, + key_or_value, + valid_classes_phrase, + type(var_value).__name__, + ) + ) + return msg + + +def get_valid_classes_phrase(input_classes): + """Returns a string phrase describing what types are allowed + """ + all_classes = list(input_classes) + all_classes = sorted(all_classes, key=lambda cls: cls.__name__) + all_class_names = [cls.__name__ for cls in all_classes] + if len(all_class_names) == 1: + return 'is {0}'.format(all_class_names[0]) + return "is one of [{0}]".format(", ".join(all_class_names)) + + +def get_allof_instances(self, model_args, constant_args): + """ + Args: + self: the class we are handling + model_args (dict): var_name to var_value + used to make instances + constant_args (dict): + metadata arguments: + _check_type + _path_to_item + _spec_property_naming + _configuration + _visited_composed_classes + + Returns + composed_instances (list) + """ + composed_instances = [] + for allof_class in self._composed_schemas['allOf']: + + try: + if constant_args.get('_spec_property_naming'): + allof_instance = allof_class._from_openapi_data(**model_args, **constant_args) + else: + allof_instance = allof_class(**model_args, **constant_args) + composed_instances.append(allof_instance) + except Exception as ex: + raise ApiValueError( + "Invalid inputs given to generate an instance of '%s'. The " + "input data was invalid for the allOf schema '%s' in the composed " + "schema '%s'. Error=%s" % ( + allof_class.__name__, + allof_class.__name__, + self.__class__.__name__, + str(ex) + ) + ) from ex + return composed_instances + + +def get_oneof_instance(cls, model_kwargs, constant_kwargs, model_arg=None): + """ + Find the oneOf schema that matches the input data (e.g. payload). + If exactly one schema matches the input data, an instance of that schema + is returned. + If zero or more than one schema match the input data, an exception is raised. + In OAS 3.x, the payload MUST, by validation, match exactly one of the + schemas described by oneOf. + + Args: + cls: the class we are handling + model_kwargs (dict): var_name to var_value + The input data, e.g. the payload that must match a oneOf schema + in the OpenAPI document. + constant_kwargs (dict): var_name to var_value + args that every model requires, including configuration, server + and path to item. + + Kwargs: + model_arg: (int, float, bool, str, date, datetime, ModelSimple, None): + the value to assign to a primitive class or ModelSimple class + Notes: + - this is only passed in when oneOf includes types which are not object + - None is used to suppress handling of model_arg, nullable models are handled in __new__ + + Returns + oneof_instance (instance) + """ + if len(cls._composed_schemas['oneOf']) == 0: + return None + + oneof_instances = [] + # Iterate over each oneOf schema and determine if the input data + # matches the oneOf schemas. + for oneof_class in cls._composed_schemas['oneOf']: + # The composed oneOf schema allows the 'null' type and the input data + # is the null value. This is a OAS >= 3.1 feature. + if oneof_class is none_type: + # skip none_types because we are deserializing dict data. + # none_type deserialization is handled in the __new__ method + continue + + single_value_input = allows_single_value_input(oneof_class) + + try: + if not single_value_input: + if constant_kwargs.get('_spec_property_naming'): + oneof_instance = oneof_class._from_openapi_data(**model_kwargs, **constant_kwargs) + else: + oneof_instance = oneof_class(**model_kwargs, **constant_kwargs) + else: + if issubclass(oneof_class, ModelSimple): + if constant_kwargs.get('_spec_property_naming'): + oneof_instance = oneof_class._from_openapi_data(model_arg, **constant_kwargs) + else: + oneof_instance = oneof_class(model_arg, **constant_kwargs) + elif oneof_class in PRIMITIVE_TYPES: + oneof_instance = validate_and_convert_types( + model_arg, + (oneof_class,), + constant_kwargs['_path_to_item'], + constant_kwargs['_spec_property_naming'], + constant_kwargs['_check_type'], + configuration=constant_kwargs['_configuration'] + ) + oneof_instances.append(oneof_instance) + except Exception: + pass + if len(oneof_instances) == 0: + raise ApiValueError( + "Invalid inputs given to generate an instance of %s. None " + "of the oneOf schemas matched the input data." % + cls.__name__ + ) + elif len(oneof_instances) > 1: + raise ApiValueError( + "Invalid inputs given to generate an instance of %s. Multiple " + "oneOf schemas matched the inputs, but a max of one is allowed." % + cls.__name__ + ) + return oneof_instances[0] + + +def get_anyof_instances(self, model_args, constant_args): + """ + Args: + self: the class we are handling + model_args (dict): var_name to var_value + The input data, e.g. the payload that must match at least one + anyOf child schema in the OpenAPI document. + constant_args (dict): var_name to var_value + args that every model requires, including configuration, server + and path to item. + + Returns + anyof_instances (list) + """ + anyof_instances = [] + if len(self._composed_schemas['anyOf']) == 0: + return anyof_instances + + for anyof_class in self._composed_schemas['anyOf']: + # The composed oneOf schema allows the 'null' type and the input data + # is the null value. This is a OAS >= 3.1 feature. + if anyof_class is none_type: + # skip none_types because we are deserializing dict data. + # none_type deserialization is handled in the __new__ method + continue + + try: + if constant_args.get('_spec_property_naming'): + anyof_instance = anyof_class._from_openapi_data(**model_args, **constant_args) + else: + anyof_instance = anyof_class(**model_args, **constant_args) + anyof_instances.append(anyof_instance) + except Exception: + pass + if len(anyof_instances) == 0: + raise ApiValueError( + "Invalid inputs given to generate an instance of %s. None of the " + "anyOf schemas matched the inputs." % + self.__class__.__name__ + ) + return anyof_instances + + +def get_discarded_args(self, composed_instances, model_args): + """ + Gathers the args that were discarded by configuration.discard_unknown_keys + """ + model_arg_keys = model_args.keys() + discarded_args = set() + # arguments passed to self were already converted to python names + # before __init__ was called + for instance in composed_instances: + if instance.__class__ in self._composed_schemas['allOf']: + try: + keys = instance.to_dict().keys() + discarded_keys = model_args - keys + discarded_args.update(discarded_keys) + except Exception: + # allOf integer schema will throw exception + pass + else: + try: + all_keys = set(model_to_dict(instance, serialize=False).keys()) + js_keys = model_to_dict(instance, serialize=True).keys() + all_keys.update(js_keys) + discarded_keys = model_arg_keys - all_keys + discarded_args.update(discarded_keys) + except Exception: + # allOf integer schema will throw exception + pass + return discarded_args + + +def validate_get_composed_info(constant_args, model_args, self): + """ + For composed schemas, generate schema instances for + all schemas in the oneOf/anyOf/allOf definition. If additional + properties are allowed, also assign those properties on + all matched schemas that contain additionalProperties. + Openapi schemas are python classes. + + Exceptions are raised if: + - 0 or > 1 oneOf schema matches the model_args input data + - no anyOf schema matches the model_args input data + - any of the allOf schemas do not match the model_args input data + + Args: + constant_args (dict): these are the args that every model requires + model_args (dict): these are the required and optional spec args that + were passed in to make this model + self (class): the class that we are instantiating + This class contains self._composed_schemas + + Returns: + composed_info (list): length three + composed_instances (list): the composed instances which are not + self + var_name_to_model_instances (dict): a dict going from var_name + to the model_instance which holds that var_name + the model_instance may be self or an instance of one of the + classes in self.composed_instances() + additional_properties_model_instances (list): a list of the + model instances which have the property + additional_properties_type. This list can include self + """ + # create composed_instances + composed_instances = [] + allof_instances = get_allof_instances(self, model_args, constant_args) + composed_instances.extend(allof_instances) + oneof_instance = get_oneof_instance(self.__class__, model_args, constant_args) + if oneof_instance is not None: + composed_instances.append(oneof_instance) + anyof_instances = get_anyof_instances(self, model_args, constant_args) + composed_instances.extend(anyof_instances) + """ + set additional_properties_model_instances + additional properties must be evaluated at the schema level + so self's additional properties are most important + If self is a composed schema with: + - no properties defined in self + - additionalProperties: False + Then for object payloads every property is an additional property + and they are not allowed, so only empty dict is allowed + + Properties must be set on all matching schemas + so when a property is assigned toa composed instance, it must be set on all + composed instances regardless of additionalProperties presence + keeping it to prevent breaking changes in v5.0.1 + TODO remove cls._additional_properties_model_instances in 6.0.0 + """ + additional_properties_model_instances = [] + if self.additional_properties_type is not None: + additional_properties_model_instances = [self] + + """ + no need to set properties on self in here, they will be set in __init__ + By here all composed schema oneOf/anyOf/allOf instances have their properties set using + model_args + """ + discarded_args = get_discarded_args(self, composed_instances, model_args) + + # map variable names to composed_instances + var_name_to_model_instances = {} + for prop_name in model_args: + if prop_name not in discarded_args: + var_name_to_model_instances[prop_name] = [self] + composed_instances + + return [ + composed_instances, + var_name_to_model_instances, + additional_properties_model_instances, + discarded_args + ] diff --git a/src/apideck/models/__init__.py b/src/apideck/models/__init__.py new file mode 100644 index 0000000000..3285c0cadc --- /dev/null +++ b/src/apideck/models/__init__.py @@ -0,0 +1,511 @@ +# flake8: noqa + +# import all models into this package +# if you have many models here with many references from one model to another this may +# raise a RecursionError +# to avoid this, import only the models that you directly need like: +# from from apideck.model.pet import Pet +# or import this package, but before doing it, use: +# import sys +# sys.setrecursionlimit(n) + +from apideck.model.accounting_customer import AccountingCustomer +from apideck.model.accounting_event_type import AccountingEventType +from apideck.model.activity import Activity +from apideck.model.activity_attendee import ActivityAttendee +from apideck.model.address import Address +from apideck.model.api import Api +from apideck.model.api_resource import ApiResource +from apideck.model.api_resource_coverage import ApiResourceCoverage +from apideck.model.api_resource_coverage_coverage import ApiResourceCoverageCoverage +from apideck.model.api_resource_linked_resources import ApiResourceLinkedResources +from apideck.model.api_resources import ApiResources +from apideck.model.api_status import ApiStatus +from apideck.model.apis_filter import ApisFilter +from apideck.model.applicant import Applicant +from apideck.model.applicant_social_links import ApplicantSocialLinks +from apideck.model.applicant_websites import ApplicantWebsites +from apideck.model.applicants_filter import ApplicantsFilter +from apideck.model.ats_activity import AtsActivity +from apideck.model.ats_event_type import AtsEventType +from apideck.model.auth_type import AuthType +from apideck.model.bad_request_response import BadRequestResponse +from apideck.model.balance_sheet import BalanceSheet +from apideck.model.balance_sheet_assets import BalanceSheetAssets +from apideck.model.balance_sheet_assets_current_assets import BalanceSheetAssetsCurrentAssets +from apideck.model.balance_sheet_assets_current_assets_accounts import BalanceSheetAssetsCurrentAssetsAccounts +from apideck.model.balance_sheet_assets_fixed_assets import BalanceSheetAssetsFixedAssets +from apideck.model.balance_sheet_assets_fixed_assets_accounts import BalanceSheetAssetsFixedAssetsAccounts +from apideck.model.balance_sheet_equity import BalanceSheetEquity +from apideck.model.balance_sheet_equity_items import BalanceSheetEquityItems +from apideck.model.balance_sheet_filter import BalanceSheetFilter +from apideck.model.balance_sheet_liabilities import BalanceSheetLiabilities +from apideck.model.balance_sheet_liabilities_accounts import BalanceSheetLiabilitiesAccounts +from apideck.model.bank_account import BankAccount +from apideck.model.benefit import Benefit +from apideck.model.bill import Bill +from apideck.model.bill_line_item import BillLineItem +from apideck.model.branch import Branch +from apideck.model.cash_details import CashDetails +from apideck.model.companies_filter import CompaniesFilter +from apideck.model.companies_sort import CompaniesSort +from apideck.model.company import Company +from apideck.model.company_info import CompanyInfo +from apideck.model.company_row_type import CompanyRowType +from apideck.model.compensation import Compensation +from apideck.model.connection import Connection +from apideck.model.connection_configuration import ConnectionConfiguration +from apideck.model.connection_defaults import ConnectionDefaults +from apideck.model.connection_import_data import ConnectionImportData +from apideck.model.connection_import_data_credentials import ConnectionImportDataCredentials +from apideck.model.connection_metadata import ConnectionMetadata +from apideck.model.connection_state import ConnectionState +from apideck.model.connection_webhook import ConnectionWebhook +from apideck.model.connector import Connector +from apideck.model.connector_doc import ConnectorDoc +from apideck.model.connector_event import ConnectorEvent +from apideck.model.connector_oauth_scopes import ConnectorOauthScopes +from apideck.model.connector_oauth_scopes1 import ConnectorOauthScopes1 +from apideck.model.connector_resource import ConnectorResource +from apideck.model.connector_setting import ConnectorSetting +from apideck.model.connector_status import ConnectorStatus +from apideck.model.connector_tls_support import ConnectorTlsSupport +from apideck.model.connector_unified_apis import ConnectorUnifiedApis +from apideck.model.connectors_filter import ConnectorsFilter +from apideck.model.consumer import Consumer +from apideck.model.consumer_connection import ConsumerConnection +from apideck.model.consumer_metadata import ConsumerMetadata +from apideck.model.consumer_request_counts_in_date_range_response import ConsumerRequestCountsInDateRangeResponse +from apideck.model.consumer_request_counts_in_date_range_response_data import ConsumerRequestCountsInDateRangeResponseData +from apideck.model.contact import Contact +from apideck.model.contacts_filter import ContactsFilter +from apideck.model.contacts_sort import ContactsSort +from apideck.model.copy_folder_request import CopyFolderRequest +from apideck.model.create_activity_response import CreateActivityResponse +from apideck.model.create_applicant_response import CreateApplicantResponse +from apideck.model.create_bill_response import CreateBillResponse +from apideck.model.create_company_response import CreateCompanyResponse +from apideck.model.create_connection_response import CreateConnectionResponse +from apideck.model.create_contact_response import CreateContactResponse +from apideck.model.create_credit_note_response import CreateCreditNoteResponse +from apideck.model.create_customer_response import CreateCustomerResponse +from apideck.model.create_customer_support_customer_response import CreateCustomerSupportCustomerResponse +from apideck.model.create_department_response import CreateDepartmentResponse +from apideck.model.create_drive_group_response import CreateDriveGroupResponse +from apideck.model.create_drive_response import CreateDriveResponse +from apideck.model.create_employee_response import CreateEmployeeResponse +from apideck.model.create_file_request import CreateFileRequest +from apideck.model.create_file_response import CreateFileResponse +from apideck.model.create_folder_request import CreateFolderRequest +from apideck.model.create_folder_response import CreateFolderResponse +from apideck.model.create_hris_company_response import CreateHrisCompanyResponse +from apideck.model.create_invoice_item_response import CreateInvoiceItemResponse +from apideck.model.create_invoice_response import CreateInvoiceResponse +from apideck.model.create_item_response import CreateItemResponse +from apideck.model.create_job_response import CreateJobResponse +from apideck.model.create_lead_response import CreateLeadResponse +from apideck.model.create_ledger_account_response import CreateLedgerAccountResponse +from apideck.model.create_location_response import CreateLocationResponse +from apideck.model.create_merchant_response import CreateMerchantResponse +from apideck.model.create_message_response import CreateMessageResponse +from apideck.model.create_modifier_group_response import CreateModifierGroupResponse +from apideck.model.create_modifier_response import CreateModifierResponse +from apideck.model.create_note_response import CreateNoteResponse +from apideck.model.create_opportunity_response import CreateOpportunityResponse +from apideck.model.create_order_response import CreateOrderResponse +from apideck.model.create_order_type_response import CreateOrderTypeResponse +from apideck.model.create_payment_response import CreatePaymentResponse +from apideck.model.create_pipeline_response import CreatePipelineResponse +from apideck.model.create_pos_payment_response import CreatePosPaymentResponse +from apideck.model.create_session_response import CreateSessionResponse +from apideck.model.create_session_response_data import CreateSessionResponseData +from apideck.model.create_shared_link_response import CreateSharedLinkResponse +from apideck.model.create_supplier_response import CreateSupplierResponse +from apideck.model.create_tax_rate_response import CreateTaxRateResponse +from apideck.model.create_tender_response import CreateTenderResponse +from apideck.model.create_time_off_request_response import CreateTimeOffRequestResponse +from apideck.model.create_upload_session_request import CreateUploadSessionRequest +from apideck.model.create_upload_session_response import CreateUploadSessionResponse +from apideck.model.create_user_response import CreateUserResponse +from apideck.model.create_webhook_request import CreateWebhookRequest +from apideck.model.create_webhook_response import CreateWebhookResponse +from apideck.model.credit_note import CreditNote +from apideck.model.crm_event_type import CrmEventType +from apideck.model.currency import Currency +from apideck.model.custom_field import CustomField +from apideck.model.customer_support_customer import CustomerSupportCustomer +from apideck.model.customers_filter import CustomersFilter +from apideck.model.deduction import Deduction +from apideck.model.delete_activity_response import DeleteActivityResponse +from apideck.model.delete_bill_response import DeleteBillResponse +from apideck.model.delete_company_response import DeleteCompanyResponse +from apideck.model.delete_contact_response import DeleteContactResponse +from apideck.model.delete_credit_note_response import DeleteCreditNoteResponse +from apideck.model.delete_customer_response import DeleteCustomerResponse +from apideck.model.delete_customer_support_customer_response import DeleteCustomerSupportCustomerResponse +from apideck.model.delete_department_response import DeleteDepartmentResponse +from apideck.model.delete_drive_group_response import DeleteDriveGroupResponse +from apideck.model.delete_drive_response import DeleteDriveResponse +from apideck.model.delete_employee_response import DeleteEmployeeResponse +from apideck.model.delete_file_response import DeleteFileResponse +from apideck.model.delete_folder_response import DeleteFolderResponse +from apideck.model.delete_hris_company_response import DeleteHrisCompanyResponse +from apideck.model.delete_invoice_item_response import DeleteInvoiceItemResponse +from apideck.model.delete_invoice_response import DeleteInvoiceResponse +from apideck.model.delete_item_response import DeleteItemResponse +from apideck.model.delete_job_response import DeleteJobResponse +from apideck.model.delete_lead_response import DeleteLeadResponse +from apideck.model.delete_ledger_account_response import DeleteLedgerAccountResponse +from apideck.model.delete_location_response import DeleteLocationResponse +from apideck.model.delete_merchant_response import DeleteMerchantResponse +from apideck.model.delete_message_response import DeleteMessageResponse +from apideck.model.delete_modifier_group_response import DeleteModifierGroupResponse +from apideck.model.delete_modifier_response import DeleteModifierResponse +from apideck.model.delete_note_response import DeleteNoteResponse +from apideck.model.delete_opportunity_response import DeleteOpportunityResponse +from apideck.model.delete_order_response import DeleteOrderResponse +from apideck.model.delete_order_type_response import DeleteOrderTypeResponse +from apideck.model.delete_payment_response import DeletePaymentResponse +from apideck.model.delete_pipeline_response import DeletePipelineResponse +from apideck.model.delete_pos_payment_response import DeletePosPaymentResponse +from apideck.model.delete_shared_link_response import DeleteSharedLinkResponse +from apideck.model.delete_supplier_response import DeleteSupplierResponse +from apideck.model.delete_tax_rate_response import DeleteTaxRateResponse +from apideck.model.delete_tender_response import DeleteTenderResponse +from apideck.model.delete_time_off_request_response import DeleteTimeOffRequestResponse +from apideck.model.delete_upload_session_response import DeleteUploadSessionResponse +from apideck.model.delete_user_response import DeleteUserResponse +from apideck.model.delete_webhook_response import DeleteWebhookResponse +from apideck.model.delivery_url import DeliveryUrl +from apideck.model.department import Department +from apideck.model.drive import Drive +from apideck.model.drive_group import DriveGroup +from apideck.model.drive_groups_filter import DriveGroupsFilter +from apideck.model.drives_filter import DrivesFilter +from apideck.model.email import Email +from apideck.model.employee import Employee +from apideck.model.employee_compensations import EmployeeCompensations +from apideck.model.employee_employment_role import EmployeeEmploymentRole +from apideck.model.employee_jobs import EmployeeJobs +from apideck.model.employee_manager import EmployeeManager +from apideck.model.employee_partner import EmployeePartner +from apideck.model.employee_payroll import EmployeePayroll +from apideck.model.employee_payrolls import EmployeePayrolls +from apideck.model.employee_schedules import EmployeeSchedules +from apideck.model.employee_team import EmployeeTeam +from apideck.model.employees_filter import EmployeesFilter +from apideck.model.error import Error +from apideck.model.execute_base_url import ExecuteBaseUrl +from apideck.model.execute_webhook_event_request import ExecuteWebhookEventRequest +from apideck.model.execute_webhook_events_request import ExecuteWebhookEventsRequest +from apideck.model.execute_webhook_response import ExecuteWebhookResponse +from apideck.model.file_storage_event_type import FileStorageEventType +from apideck.model.file_type import FileType +from apideck.model.files_filter import FilesFilter +from apideck.model.files_search import FilesSearch +from apideck.model.files_sort import FilesSort +from apideck.model.folder import Folder +from apideck.model.form_field import FormField +from apideck.model.form_field_option import FormFieldOption +from apideck.model.form_field_option_group import FormFieldOptionGroup +from apideck.model.gender import Gender +from apideck.model.get_activities_response import GetActivitiesResponse +from apideck.model.get_activity_response import GetActivityResponse +from apideck.model.get_api_resource_coverage_response import GetApiResourceCoverageResponse +from apideck.model.get_api_resource_response import GetApiResourceResponse +from apideck.model.get_api_response import GetApiResponse +from apideck.model.get_apis_response import GetApisResponse +from apideck.model.get_applicant_response import GetApplicantResponse +from apideck.model.get_applicants_response import GetApplicantsResponse +from apideck.model.get_balance_sheet_response import GetBalanceSheetResponse +from apideck.model.get_bill_response import GetBillResponse +from apideck.model.get_bills_response import GetBillsResponse +from apideck.model.get_companies_response import GetCompaniesResponse +from apideck.model.get_company_info_response import GetCompanyInfoResponse +from apideck.model.get_company_response import GetCompanyResponse +from apideck.model.get_connection_response import GetConnectionResponse +from apideck.model.get_connections_response import GetConnectionsResponse +from apideck.model.get_connector_resource_response import GetConnectorResourceResponse +from apideck.model.get_connector_response import GetConnectorResponse +from apideck.model.get_connectors_response import GetConnectorsResponse +from apideck.model.get_consumer_response import GetConsumerResponse +from apideck.model.get_consumers_response import GetConsumersResponse +from apideck.model.get_consumers_response_data import GetConsumersResponseData +from apideck.model.get_contact_response import GetContactResponse +from apideck.model.get_contacts_response import GetContactsResponse +from apideck.model.get_credit_note_response import GetCreditNoteResponse +from apideck.model.get_credit_notes_response import GetCreditNotesResponse +from apideck.model.get_customer_response import GetCustomerResponse +from apideck.model.get_customer_support_customer_response import GetCustomerSupportCustomerResponse +from apideck.model.get_customer_support_customers_response import GetCustomerSupportCustomersResponse +from apideck.model.get_customers_response import GetCustomersResponse +from apideck.model.get_department_response import GetDepartmentResponse +from apideck.model.get_departments_response import GetDepartmentsResponse +from apideck.model.get_drive_group_response import GetDriveGroupResponse +from apideck.model.get_drive_groups_response import GetDriveGroupsResponse +from apideck.model.get_drive_response import GetDriveResponse +from apideck.model.get_drives_response import GetDrivesResponse +from apideck.model.get_employee_payroll_response import GetEmployeePayrollResponse +from apideck.model.get_employee_payrolls_response import GetEmployeePayrollsResponse +from apideck.model.get_employee_response import GetEmployeeResponse +from apideck.model.get_employee_schedules_response import GetEmployeeSchedulesResponse +from apideck.model.get_employees_response import GetEmployeesResponse +from apideck.model.get_file_response import GetFileResponse +from apideck.model.get_files_response import GetFilesResponse +from apideck.model.get_folder_response import GetFolderResponse +from apideck.model.get_folders_response import GetFoldersResponse +from apideck.model.get_hris_companies_response import GetHrisCompaniesResponse +from apideck.model.get_hris_company_response import GetHrisCompanyResponse +from apideck.model.get_hris_job_response import GetHrisJobResponse +from apideck.model.get_hris_jobs_response import GetHrisJobsResponse +from apideck.model.get_invoice_item_response import GetInvoiceItemResponse +from apideck.model.get_invoice_items_response import GetInvoiceItemsResponse +from apideck.model.get_invoice_response import GetInvoiceResponse +from apideck.model.get_invoices_response import GetInvoicesResponse +from apideck.model.get_item_response import GetItemResponse +from apideck.model.get_items_response import GetItemsResponse +from apideck.model.get_job_response import GetJobResponse +from apideck.model.get_jobs_response import GetJobsResponse +from apideck.model.get_lead_response import GetLeadResponse +from apideck.model.get_leads_response import GetLeadsResponse +from apideck.model.get_ledger_account_response import GetLedgerAccountResponse +from apideck.model.get_ledger_accounts_response import GetLedgerAccountsResponse +from apideck.model.get_location_response import GetLocationResponse +from apideck.model.get_locations_response import GetLocationsResponse +from apideck.model.get_logs_response import GetLogsResponse +from apideck.model.get_merchant_response import GetMerchantResponse +from apideck.model.get_merchants_response import GetMerchantsResponse +from apideck.model.get_message_response import GetMessageResponse +from apideck.model.get_messages_response import GetMessagesResponse +from apideck.model.get_modifier_group_response import GetModifierGroupResponse +from apideck.model.get_modifier_groups_response import GetModifierGroupsResponse +from apideck.model.get_modifier_response import GetModifierResponse +from apideck.model.get_modifiers_response import GetModifiersResponse +from apideck.model.get_note_response import GetNoteResponse +from apideck.model.get_notes_response import GetNotesResponse +from apideck.model.get_opportunities_response import GetOpportunitiesResponse +from apideck.model.get_opportunity_response import GetOpportunityResponse +from apideck.model.get_order_response import GetOrderResponse +from apideck.model.get_order_type_response import GetOrderTypeResponse +from apideck.model.get_order_types_response import GetOrderTypesResponse +from apideck.model.get_orders_response import GetOrdersResponse +from apideck.model.get_payment_response import GetPaymentResponse +from apideck.model.get_payments_response import GetPaymentsResponse +from apideck.model.get_payroll_response import GetPayrollResponse +from apideck.model.get_payrolls_response import GetPayrollsResponse +from apideck.model.get_pipeline_response import GetPipelineResponse +from apideck.model.get_pipelines_response import GetPipelinesResponse +from apideck.model.get_pos_payment_response import GetPosPaymentResponse +from apideck.model.get_pos_payments_response import GetPosPaymentsResponse +from apideck.model.get_profit_and_loss_response import GetProfitAndLossResponse +from apideck.model.get_shared_link_response import GetSharedLinkResponse +from apideck.model.get_shared_links_response import GetSharedLinksResponse +from apideck.model.get_supplier_response import GetSupplierResponse +from apideck.model.get_suppliers_response import GetSuppliersResponse +from apideck.model.get_tax_rate_response import GetTaxRateResponse +from apideck.model.get_tax_rates_response import GetTaxRatesResponse +from apideck.model.get_tender_response import GetTenderResponse +from apideck.model.get_tenders_response import GetTendersResponse +from apideck.model.get_time_off_request_response import GetTimeOffRequestResponse +from apideck.model.get_time_off_requests_response import GetTimeOffRequestsResponse +from apideck.model.get_upload_session_response import GetUploadSessionResponse +from apideck.model.get_user_response import GetUserResponse +from apideck.model.get_users_response import GetUsersResponse +from apideck.model.get_webhook_event_logs_response import GetWebhookEventLogsResponse +from apideck.model.get_webhook_response import GetWebhookResponse +from apideck.model.get_webhooks_response import GetWebhooksResponse +from apideck.model.hris_company import HrisCompany +from apideck.model.hris_event_type import HrisEventType +from apideck.model.hris_job import HrisJob +from apideck.model.hris_job_location import HrisJobLocation +from apideck.model.hris_jobs import HrisJobs +from apideck.model.idempotency_key import IdempotencyKey +from apideck.model.invoice import Invoice +from apideck.model.invoice_item import InvoiceItem +from apideck.model.invoice_item_asset_account import InvoiceItemAssetAccount +from apideck.model.invoice_item_expense_account import InvoiceItemExpenseAccount +from apideck.model.invoice_item_income_account import InvoiceItemIncomeAccount +from apideck.model.invoice_item_sales_details import InvoiceItemSalesDetails +from apideck.model.invoice_items_filter import InvoiceItemsFilter +from apideck.model.invoice_line_item import InvoiceLineItem +from apideck.model.invoice_response import InvoiceResponse +from apideck.model.invoices_sort import InvoicesSort +from apideck.model.item import Item +from apideck.model.job import Job +from apideck.model.job_salary import JobSalary +from apideck.model.job_status import JobStatus +from apideck.model.jobs_filter import JobsFilter +from apideck.model.lead import Lead +from apideck.model.lead_event_type import LeadEventType +from apideck.model.leads_filter import LeadsFilter +from apideck.model.leads_sort import LeadsSort +from apideck.model.ledger_account import LedgerAccount +from apideck.model.ledger_account_categories import LedgerAccountCategories +from apideck.model.ledger_account_parent_account import LedgerAccountParentAccount +from apideck.model.ledger_accounts import LedgerAccounts +from apideck.model.linked_connector_resource import LinkedConnectorResource +from apideck.model.linked_customer import LinkedCustomer +from apideck.model.linked_folder import LinkedFolder +from apideck.model.linked_invoice_item import LinkedInvoiceItem +from apideck.model.linked_ledger_account import LinkedLedgerAccount +from apideck.model.linked_supplier import LinkedSupplier +from apideck.model.linked_tax_rate import LinkedTaxRate +from apideck.model.links import Links +from apideck.model.location import Location +from apideck.model.log import Log +from apideck.model.log_operation import LogOperation +from apideck.model.log_service import LogService +from apideck.model.logs_filter import LogsFilter +from apideck.model.merchant import Merchant +from apideck.model.message import Message +from apideck.model.meta import Meta +from apideck.model.meta_cursors import MetaCursors +from apideck.model.modifier import Modifier +from apideck.model.modifier_group import ModifierGroup +from apideck.model.modifier_group_filter import ModifierGroupFilter +from apideck.model.not_found_response import NotFoundResponse +from apideck.model.not_implemented_response import NotImplementedResponse +from apideck.model.note import Note +from apideck.model.o_auth_grant_type import OAuthGrantType +from apideck.model.offer import Offer +from apideck.model.opportunities_filter import OpportunitiesFilter +from apideck.model.opportunities_sort import OpportunitiesSort +from apideck.model.opportunity import Opportunity +from apideck.model.order import Order +from apideck.model.order_customers import OrderCustomers +from apideck.model.order_discounts import OrderDiscounts +from apideck.model.order_fulfillments import OrderFulfillments +from apideck.model.order_line_items import OrderLineItems +from apideck.model.order_payments import OrderPayments +from apideck.model.order_pickup_details import OrderPickupDetails +from apideck.model.order_pickup_details_curbside_pickup_details import OrderPickupDetailsCurbsidePickupDetails +from apideck.model.order_pickup_details_recipient import OrderPickupDetailsRecipient +from apideck.model.order_refunds import OrderRefunds +from apideck.model.order_tenders import OrderTenders +from apideck.model.order_type import OrderType +from apideck.model.owner import Owner +from apideck.model.pagination_coverage import PaginationCoverage +from apideck.model.passthrough import Passthrough +from apideck.model.payment import Payment +from apideck.model.payment_allocations import PaymentAllocations +from apideck.model.payment_card import PaymentCard +from apideck.model.payment_required_response import PaymentRequiredResponse +from apideck.model.payment_unit import PaymentUnit +from apideck.model.payroll import Payroll +from apideck.model.payroll_totals import PayrollTotals +from apideck.model.payrolls_filter import PayrollsFilter +from apideck.model.phone_number import PhoneNumber +from apideck.model.pipeline import Pipeline +from apideck.model.pipeline_stages import PipelineStages +from apideck.model.pos_bank_account import PosBankAccount +from apideck.model.pos_bank_account_ach_details import PosBankAccountAchDetails +from apideck.model.pos_payment import PosPayment +from apideck.model.pos_payment_card_details import PosPaymentCardDetails +from apideck.model.pos_payment_external_details import PosPaymentExternalDetails +from apideck.model.price import Price +from apideck.model.profit_and_loss import ProfitAndLoss +from apideck.model.profit_and_loss_expenses import ProfitAndLossExpenses +from apideck.model.profit_and_loss_filter import ProfitAndLossFilter +from apideck.model.profit_and_loss_gross_profit import ProfitAndLossGrossProfit +from apideck.model.profit_and_loss_income import ProfitAndLossIncome +from apideck.model.profit_and_loss_net_income import ProfitAndLossNetIncome +from apideck.model.profit_and_loss_net_operating_income import ProfitAndLossNetOperatingIncome +from apideck.model.profit_and_loss_record import ProfitAndLossRecord +from apideck.model.profit_and_loss_records import ProfitAndLossRecords +from apideck.model.profit_and_loss_section import ProfitAndLossSection +from apideck.model.request_count_allocation import RequestCountAllocation +from apideck.model.resolve_webhook_event_request import ResolveWebhookEventRequest +from apideck.model.resolve_webhook_events_request import ResolveWebhookEventsRequest +from apideck.model.resolve_webhook_response import ResolveWebhookResponse +from apideck.model.resource_status import ResourceStatus +from apideck.model.schedule import Schedule +from apideck.model.schedule_work_pattern import ScheduleWorkPattern +from apideck.model.schedule_work_pattern_odd_weeks import ScheduleWorkPatternOddWeeks +from apideck.model.service_charge import ServiceCharge +from apideck.model.service_charges import ServiceCharges +from apideck.model.session import Session +from apideck.model.session_settings import SessionSettings +from apideck.model.session_theme import SessionTheme +from apideck.model.shared_link import SharedLink +from apideck.model.shared_link_target import SharedLinkTarget +from apideck.model.simple_form_field_option import SimpleFormFieldOption +from apideck.model.social_link import SocialLink +from apideck.model.sort_direction import SortDirection +from apideck.model.status import Status +from apideck.model.supplier import Supplier +from apideck.model.supported_property import SupportedProperty +from apideck.model.supported_property_child_properties import SupportedPropertyChildProperties +from apideck.model.tags import Tags +from apideck.model.tax import Tax +from apideck.model.tax_rate import TaxRate +from apideck.model.tax_rates_filter import TaxRatesFilter +from apideck.model.tender import Tender +from apideck.model.time_off_request import TimeOffRequest +from apideck.model.time_off_request_notes import TimeOffRequestNotes +from apideck.model.time_off_requests_filter import TimeOffRequestsFilter +from apideck.model.too_many_requests_response import TooManyRequestsResponse +from apideck.model.too_many_requests_response_detail import TooManyRequestsResponseDetail +from apideck.model.unauthorized_response import UnauthorizedResponse +from apideck.model.unexpected_error_response import UnexpectedErrorResponse +from apideck.model.unified_api_id import UnifiedApiId +from apideck.model.unified_file import UnifiedFile +from apideck.model.unified_id import UnifiedId +from apideck.model.unprocessable_response import UnprocessableResponse +from apideck.model.update_activity_response import UpdateActivityResponse +from apideck.model.update_bill_response import UpdateBillResponse +from apideck.model.update_company_response import UpdateCompanyResponse +from apideck.model.update_connection_response import UpdateConnectionResponse +from apideck.model.update_contact_response import UpdateContactResponse +from apideck.model.update_credit_note_response import UpdateCreditNoteResponse +from apideck.model.update_customer_response import UpdateCustomerResponse +from apideck.model.update_customer_support_customer_response import UpdateCustomerSupportCustomerResponse +from apideck.model.update_department_response import UpdateDepartmentResponse +from apideck.model.update_drive_group_response import UpdateDriveGroupResponse +from apideck.model.update_drive_response import UpdateDriveResponse +from apideck.model.update_employee_response import UpdateEmployeeResponse +from apideck.model.update_file_response import UpdateFileResponse +from apideck.model.update_folder_request import UpdateFolderRequest +from apideck.model.update_folder_response import UpdateFolderResponse +from apideck.model.update_hris_company_response import UpdateHrisCompanyResponse +from apideck.model.update_invoice_items_response import UpdateInvoiceItemsResponse +from apideck.model.update_invoice_response import UpdateInvoiceResponse +from apideck.model.update_item_response import UpdateItemResponse +from apideck.model.update_job_response import UpdateJobResponse +from apideck.model.update_lead_response import UpdateLeadResponse +from apideck.model.update_ledger_account_response import UpdateLedgerAccountResponse +from apideck.model.update_location_response import UpdateLocationResponse +from apideck.model.update_merchant_response import UpdateMerchantResponse +from apideck.model.update_message_response import UpdateMessageResponse +from apideck.model.update_modifier_group_response import UpdateModifierGroupResponse +from apideck.model.update_modifier_response import UpdateModifierResponse +from apideck.model.update_note_response import UpdateNoteResponse +from apideck.model.update_opportunity_response import UpdateOpportunityResponse +from apideck.model.update_order_response import UpdateOrderResponse +from apideck.model.update_order_type_response import UpdateOrderTypeResponse +from apideck.model.update_payment_response import UpdatePaymentResponse +from apideck.model.update_pipeline_response import UpdatePipelineResponse +from apideck.model.update_pos_payment_response import UpdatePosPaymentResponse +from apideck.model.update_shared_link_response import UpdateSharedLinkResponse +from apideck.model.update_supplier_response import UpdateSupplierResponse +from apideck.model.update_tax_rate_response import UpdateTaxRateResponse +from apideck.model.update_tender_response import UpdateTenderResponse +from apideck.model.update_time_off_request_response import UpdateTimeOffRequestResponse +from apideck.model.update_upload_session_response import UpdateUploadSessionResponse +from apideck.model.update_user_response import UpdateUserResponse +from apideck.model.update_webhook_request import UpdateWebhookRequest +from apideck.model.update_webhook_response import UpdateWebhookResponse +from apideck.model.upload_session import UploadSession +from apideck.model.url import Url +from apideck.model.user import User +from apideck.model.vault_event_type import VaultEventType +from apideck.model.wallet_details import WalletDetails +from apideck.model.webhook import Webhook +from apideck.model.webhook_event_log import WebhookEventLog +from apideck.model.webhook_event_log_attempts import WebhookEventLogAttempts +from apideck.model.webhook_event_log_service import WebhookEventLogService +from apideck.model.webhook_event_logs_filter import WebhookEventLogsFilter +from apideck.model.webhook_event_logs_filter_service import WebhookEventLogsFilterService +from apideck.model.webhook_event_type import WebhookEventType +from apideck.model.webhook_subscription import WebhookSubscription +from apideck.model.webhook_support import WebhookSupport +from apideck.model.website import Website diff --git a/src/apideck/rest.py b/src/apideck/rest.py new file mode 100644 index 0000000000..280ffc4deb --- /dev/null +++ b/src/apideck/rest.py @@ -0,0 +1,346 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import io +import json +import logging +import re +import ssl +from urllib.parse import urlencode +from urllib.parse import urlparse +from urllib.request import proxy_bypass_environment +import urllib3 +import ipaddress + +from apideck.exceptions import ApiException, UnauthorizedException, ForbiddenException, NotFoundException, ServiceException, ApiValueError + + +logger = logging.getLogger(__name__) + + +class RESTResponse(io.IOBase): + + def __init__(self, resp): + self.urllib3_response = resp + self.status = resp.status + self.reason = resp.reason + self.data = resp.data + + def getheaders(self): + """Returns a dictionary of the response headers.""" + return self.urllib3_response.getheaders() + + def getheader(self, name, default=None): + """Returns a given response header.""" + return self.urllib3_response.getheader(name, default) + + +class RESTClientObject(object): + + def __init__(self, configuration, pools_size=4, maxsize=None): + # urllib3.PoolManager will pass all kw parameters to connectionpool + # https://github.com/shazow/urllib3/blob/f9409436f83aeb79fbaf090181cd81b784f1b8ce/urllib3/poolmanager.py#L75 # noqa: E501 + # https://github.com/shazow/urllib3/blob/f9409436f83aeb79fbaf090181cd81b784f1b8ce/urllib3/connectionpool.py#L680 # noqa: E501 + # maxsize is the number of requests to host that are allowed in parallel # noqa: E501 + # Custom SSL certificates and client certificates: http://urllib3.readthedocs.io/en/latest/advanced-usage.html # noqa: E501 + + # cert_reqs + if configuration.verify_ssl: + cert_reqs = ssl.CERT_REQUIRED + else: + cert_reqs = ssl.CERT_NONE + + addition_pool_args = {} + if configuration.assert_hostname is not None: + addition_pool_args['assert_hostname'] = configuration.assert_hostname # noqa: E501 + + if configuration.retries is not None: + addition_pool_args['retries'] = configuration.retries + + if configuration.socket_options is not None: + addition_pool_args['socket_options'] = configuration.socket_options + + if maxsize is None: + if configuration.connection_pool_maxsize is not None: + maxsize = configuration.connection_pool_maxsize + else: + maxsize = 4 + + # https pool manager + if configuration.proxy and not should_bypass_proxies(configuration.host, no_proxy=configuration.no_proxy or ''): + self.pool_manager = urllib3.ProxyManager( + num_pools=pools_size, + maxsize=maxsize, + cert_reqs=cert_reqs, + ca_certs=configuration.ssl_ca_cert, + cert_file=configuration.cert_file, + key_file=configuration.key_file, + proxy_url=configuration.proxy, + proxy_headers=configuration.proxy_headers, + **addition_pool_args + ) + else: + self.pool_manager = urllib3.PoolManager( + num_pools=pools_size, + maxsize=maxsize, + cert_reqs=cert_reqs, + ca_certs=configuration.ssl_ca_cert, + cert_file=configuration.cert_file, + key_file=configuration.key_file, + **addition_pool_args + ) + + def request(self, method, url, query_params=None, headers=None, + body=None, post_params=None, _preload_content=True, + _request_timeout=None): + """Perform requests. + + :param method: http request method + :param url: http request url + :param query_params: query parameters in the url + :param headers: http request headers + :param body: request json body, for `application/json` + :param post_params: request post parameters, + `application/x-www-form-urlencoded` + and `multipart/form-data` + :param _preload_content: if False, the urllib3.HTTPResponse object will + be returned without reading/decoding response + data. Default is True. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + """ + method = method.upper() + assert method in ['GET', 'HEAD', 'DELETE', 'POST', 'PUT', + 'PATCH', 'OPTIONS'] + + if post_params and body: + raise ApiValueError( + "body parameter cannot be used with post_params parameter." + ) + + post_params = post_params or {} + headers = headers or {} + + timeout = None + if _request_timeout: + if isinstance(_request_timeout, (int, float)): # noqa: E501,F821 + timeout = urllib3.Timeout(total=_request_timeout) + elif (isinstance(_request_timeout, tuple) and + len(_request_timeout) == 2): + timeout = urllib3.Timeout( + connect=_request_timeout[0], read=_request_timeout[1]) + + try: + # For `POST`, `PUT`, `PATCH`, `OPTIONS`, `DELETE` + if method in ['POST', 'PUT', 'PATCH', 'OPTIONS', 'DELETE']: + # Only set a default Content-Type for POST, PUT, PATCH and OPTIONS requests + if (method != 'DELETE') and ('Content-Type' not in headers): + headers['Content-Type'] = 'application/json' + if query_params: + url += '?' + urlencode(query_params) + if ('Content-Type' not in headers) or (re.search('json', headers['Content-Type'], re.IGNORECASE)): + request_body = None + if body is not None: + request_body = json.dumps(body) + r = self.pool_manager.request( + method, url, + body=request_body, + preload_content=_preload_content, + timeout=timeout, + headers=headers) + elif headers['Content-Type'] == 'application/x-www-form-urlencoded': # noqa: E501 + r = self.pool_manager.request( + method, url, + fields=post_params, + encode_multipart=False, + preload_content=_preload_content, + timeout=timeout, + headers=headers) + elif headers['Content-Type'] == 'multipart/form-data': + # must del headers['Content-Type'], or the correct + # Content-Type which generated by urllib3 will be + # overwritten. + del headers['Content-Type'] + r = self.pool_manager.request( + method, url, + fields=post_params, + encode_multipart=True, + preload_content=_preload_content, + timeout=timeout, + headers=headers) + # Pass a `string` parameter directly in the body to support + # other content types than Json when `body` argument is + # provided in serialized form + elif isinstance(body, str) or isinstance(body, bytes): + request_body = body + r = self.pool_manager.request( + method, url, + body=request_body, + preload_content=_preload_content, + timeout=timeout, + headers=headers) + else: + # Cannot generate the request from given parameters + msg = """Cannot prepare a request message for provided + arguments. Please check that your arguments match + declared content type.""" + raise ApiException(status=0, reason=msg) + # For `GET`, `HEAD` + else: + r = self.pool_manager.request(method, url, + fields=query_params, + preload_content=_preload_content, + timeout=timeout, + headers=headers) + except urllib3.exceptions.SSLError as e: + msg = "{0}\n{1}".format(type(e).__name__, str(e)) + raise ApiException(status=0, reason=msg) + + if _preload_content: + r = RESTResponse(r) + + # log response body + logger.debug("response body: %s", r.data) + + if not 200 <= r.status <= 299: + if r.status == 401: + raise UnauthorizedException(http_resp=r) + + if r.status == 403: + raise ForbiddenException(http_resp=r) + + if r.status == 404: + raise NotFoundException(http_resp=r) + + if 500 <= r.status <= 599: + raise ServiceException(http_resp=r) + + raise ApiException(http_resp=r) + + return r + + def GET(self, url, headers=None, query_params=None, _preload_content=True, + _request_timeout=None): + return self.request("GET", url, + headers=headers, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + query_params=query_params) + + def HEAD(self, url, headers=None, query_params=None, _preload_content=True, + _request_timeout=None): + return self.request("HEAD", url, + headers=headers, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + query_params=query_params) + + def OPTIONS(self, url, headers=None, query_params=None, post_params=None, + body=None, _preload_content=True, _request_timeout=None): + return self.request("OPTIONS", url, + headers=headers, + query_params=query_params, + post_params=post_params, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + body=body) + + def DELETE(self, url, headers=None, query_params=None, body=None, + _preload_content=True, _request_timeout=None): + return self.request("DELETE", url, + headers=headers, + query_params=query_params, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + body=body) + + def POST(self, url, headers=None, query_params=None, post_params=None, + body=None, _preload_content=True, _request_timeout=None): + return self.request("POST", url, + headers=headers, + query_params=query_params, + post_params=post_params, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + body=body) + + def PUT(self, url, headers=None, query_params=None, post_params=None, + body=None, _preload_content=True, _request_timeout=None): + return self.request("PUT", url, + headers=headers, + query_params=query_params, + post_params=post_params, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + body=body) + + def PATCH(self, url, headers=None, query_params=None, post_params=None, + body=None, _preload_content=True, _request_timeout=None): + return self.request("PATCH", url, + headers=headers, + query_params=query_params, + post_params=post_params, + _preload_content=_preload_content, + _request_timeout=_request_timeout, + body=body) + +# end of class RESTClientObject +def is_ipv4(target): + """ Test if IPv4 address or not + """ + try: + chk = ipaddress.IPv4Address(target) + return True + except ipaddress.AddressValueError: + return False + +def in_ipv4net(target, net): + """ Test if target belongs to given IPv4 network + """ + try: + nw = ipaddress.IPv4Network(net) + ip = ipaddress.IPv4Address(target) + if ip in nw: + return True + return False + except ipaddress.AddressValueError: + return False + except ipaddress.NetmaskValueError: + return False + +def should_bypass_proxies(url, no_proxy=None): + """ Yet another requests.should_bypass_proxies + Test if proxies should not be used for a particular url. + """ + + parsed = urlparse(url) + + # special cases + if parsed.hostname in [None, '']: + return True + + # special cases + if no_proxy in [None , '']: + return False + if no_proxy == '*': + return True + + no_proxy = no_proxy.lower().replace(' ',''); + entries = ( + host for host in no_proxy.split(',') if host + ) + + if is_ipv4(parsed.hostname): + for item in entries: + if in_ipv4net(parsed.hostname, item): + return True + return proxy_bypass_environment(parsed.hostname, {'no': no_proxy} ) diff --git a/src/git_push.sh b/src/git_push.sh new file mode 100644 index 0000000000..6b4fc5443c --- /dev/null +++ b/src/git_push.sh @@ -0,0 +1,57 @@ +#!/bin/sh +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ +# +# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" + +git_user_id=$1 +git_repo_id=$2 +release_note=$3 +git_host=$4 + +if [ "$git_host" = "" ]; then + git_host="github.com" + echo "[INFO] No command line input provided. Set \$git_host to $git_host" +fi + +if [ "$git_user_id" = "" ]; then + git_user_id="apideck-libraries" + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" +fi + +if [ "$git_repo_id" = "" ]; then + git_repo_id="python-sdk" + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" +fi + +if [ "$release_note" = "" ]; then + release_note="Minor update" + echo "[INFO] No command line input provided. Set \$release_note to $release_note" +fi + +# Initialize the local directory as a Git repository +git init + +# Adds the files in the local repository and stages them for commit. +git add . + +# Commits the tracked changes and prepares them to be pushed to a remote repository. +git commit -m "$release_note" + +# Sets the new remote +git_remote=$(git remote) +if [ "$git_remote" = "" ]; then # git remote not defined + + if [ "$GIT_TOKEN" = "" ]; then + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." + git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git + fi + +fi + +git pull origin master + +# Pushes (Forces) the changes in the local repository up to the remote repository +echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" +git push origin master 2>&1 | grep -v 'To https' diff --git a/src/requirements.txt b/src/requirements.txt new file mode 100644 index 0000000000..96947f6040 --- /dev/null +++ b/src/requirements.txt @@ -0,0 +1,3 @@ +python_dateutil >= 2.5.3 +setuptools >= 21.0.0 +urllib3 >= 1.25.3 diff --git a/src/setup.cfg b/src/setup.cfg new file mode 100644 index 0000000000..11433ee875 --- /dev/null +++ b/src/setup.cfg @@ -0,0 +1,2 @@ +[flake8] +max-line-length=99 diff --git a/src/setup.py b/src/setup.py new file mode 100644 index 0000000000..d43fb7bd97 --- /dev/null +++ b/src/setup.py @@ -0,0 +1,42 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +from setuptools import setup, find_packages # noqa: H301 + +NAME = "apideck" +VERSION = "0.0.1" +# To install the library, run the following +# +# python setup.py install +# +# prerequisite: setuptools +# http://pypi.python.org/pypi/setuptools + +REQUIRES = [ + "urllib3 >= 1.25.3", + "python-dateutil", +] + +setup( + name=NAME, + version=VERSION, + description="Apideck", + author="OpenAPI Generator community", + author_email="team@openapitools.org", + url="", + keywords=["OpenAPI", "OpenAPI-Generator", "Apideck"], + python_requires=">=3.6", + install_requires=REQUIRES, + packages=find_packages(exclude=["test", "tests"]), + include_package_data=True, + long_description="""\ + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + """ +) diff --git a/src/test-requirements.txt b/src/test-requirements.txt new file mode 100644 index 0000000000..bb4f22bb7a --- /dev/null +++ b/src/test-requirements.txt @@ -0,0 +1 @@ +pytest-cov>=2.8.1 diff --git a/src/test/__init__.py b/src/test/__init__.py new file mode 100644 index 0000000000..e69de29bb2 diff --git a/src/test/test_accounting_api.py b/src/test/test_accounting_api.py new file mode 100644 index 0000000000..3396c65ba3 --- /dev/null +++ b/src/test/test_accounting_api.py @@ -0,0 +1,364 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import apideck +from apideck.api.accounting_api import AccountingApi # noqa: E501 + + +class TestAccountingApi(unittest.TestCase): + """AccountingApi unit test stubs""" + + def setUp(self): + self.api = AccountingApi() # noqa: E501 + + def tearDown(self): + pass + + def test_balance_sheet_one(self): + """Test case for balance_sheet_one + + Get BalanceSheet # noqa: E501 + """ + pass + + def test_bills_add(self): + """Test case for bills_add + + Create Bill # noqa: E501 + """ + pass + + def test_bills_all(self): + """Test case for bills_all + + List Bills # noqa: E501 + """ + pass + + def test_bills_delete(self): + """Test case for bills_delete + + Delete Bill # noqa: E501 + """ + pass + + def test_bills_one(self): + """Test case for bills_one + + Get Bill # noqa: E501 + """ + pass + + def test_bills_update(self): + """Test case for bills_update + + Update Bill # noqa: E501 + """ + pass + + def test_company_info_one(self): + """Test case for company_info_one + + Get company info # noqa: E501 + """ + pass + + def test_credit_notes_add(self): + """Test case for credit_notes_add + + Create Credit Note # noqa: E501 + """ + pass + + def test_credit_notes_all(self): + """Test case for credit_notes_all + + List Credit Notes # noqa: E501 + """ + pass + + def test_credit_notes_delete(self): + """Test case for credit_notes_delete + + Delete Credit Note # noqa: E501 + """ + pass + + def test_credit_notes_one(self): + """Test case for credit_notes_one + + Get Credit Note # noqa: E501 + """ + pass + + def test_credit_notes_update(self): + """Test case for credit_notes_update + + Update Credit Note # noqa: E501 + """ + pass + + def test_customers_add(self): + """Test case for customers_add + + Create Customer # noqa: E501 + """ + pass + + def test_customers_all(self): + """Test case for customers_all + + List Customers # noqa: E501 + """ + pass + + def test_customers_delete(self): + """Test case for customers_delete + + Delete Customer # noqa: E501 + """ + pass + + def test_customers_one(self): + """Test case for customers_one + + Get Customer # noqa: E501 + """ + pass + + def test_customers_update(self): + """Test case for customers_update + + Update Customer # noqa: E501 + """ + pass + + def test_invoice_items_add(self): + """Test case for invoice_items_add + + Create Invoice Item # noqa: E501 + """ + pass + + def test_invoice_items_all(self): + """Test case for invoice_items_all + + List Invoice Items # noqa: E501 + """ + pass + + def test_invoice_items_delete(self): + """Test case for invoice_items_delete + + Delete Invoice Item # noqa: E501 + """ + pass + + def test_invoice_items_one(self): + """Test case for invoice_items_one + + Get Invoice Item # noqa: E501 + """ + pass + + def test_invoice_items_update(self): + """Test case for invoice_items_update + + Update Invoice Item # noqa: E501 + """ + pass + + def test_invoices_add(self): + """Test case for invoices_add + + Create Invoice # noqa: E501 + """ + pass + + def test_invoices_all(self): + """Test case for invoices_all + + List Invoices # noqa: E501 + """ + pass + + def test_invoices_delete(self): + """Test case for invoices_delete + + Delete Invoice # noqa: E501 + """ + pass + + def test_invoices_one(self): + """Test case for invoices_one + + Get Invoice # noqa: E501 + """ + pass + + def test_invoices_update(self): + """Test case for invoices_update + + Update Invoice # noqa: E501 + """ + pass + + def test_ledger_accounts_add(self): + """Test case for ledger_accounts_add + + Create Ledger Account # noqa: E501 + """ + pass + + def test_ledger_accounts_all(self): + """Test case for ledger_accounts_all + + List Ledger Accounts # noqa: E501 + """ + pass + + def test_ledger_accounts_delete(self): + """Test case for ledger_accounts_delete + + Delete Ledger Account # noqa: E501 + """ + pass + + def test_ledger_accounts_one(self): + """Test case for ledger_accounts_one + + Get Ledger Account # noqa: E501 + """ + pass + + def test_ledger_accounts_update(self): + """Test case for ledger_accounts_update + + Update Ledger Account # noqa: E501 + """ + pass + + def test_payments_add(self): + """Test case for payments_add + + Create Payment # noqa: E501 + """ + pass + + def test_payments_all(self): + """Test case for payments_all + + List Payments # noqa: E501 + """ + pass + + def test_payments_delete(self): + """Test case for payments_delete + + Delete Payment # noqa: E501 + """ + pass + + def test_payments_one(self): + """Test case for payments_one + + Get Payment # noqa: E501 + """ + pass + + def test_payments_update(self): + """Test case for payments_update + + Update Payment # noqa: E501 + """ + pass + + def test_profit_and_loss_one(self): + """Test case for profit_and_loss_one + + Get Profit and Loss # noqa: E501 + """ + pass + + def test_suppliers_add(self): + """Test case for suppliers_add + + Create Supplier # noqa: E501 + """ + pass + + def test_suppliers_all(self): + """Test case for suppliers_all + + List Suppliers # noqa: E501 + """ + pass + + def test_suppliers_delete(self): + """Test case for suppliers_delete + + Delete Supplier # noqa: E501 + """ + pass + + def test_suppliers_one(self): + """Test case for suppliers_one + + Get Supplier # noqa: E501 + """ + pass + + def test_suppliers_update(self): + """Test case for suppliers_update + + Update Supplier # noqa: E501 + """ + pass + + def test_tax_rates_add(self): + """Test case for tax_rates_add + + Create Tax Rate # noqa: E501 + """ + pass + + def test_tax_rates_all(self): + """Test case for tax_rates_all + + List Tax Rates # noqa: E501 + """ + pass + + def test_tax_rates_delete(self): + """Test case for tax_rates_delete + + Delete Tax Rate # noqa: E501 + """ + pass + + def test_tax_rates_one(self): + """Test case for tax_rates_one + + Get Tax Rate # noqa: E501 + """ + pass + + def test_tax_rates_update(self): + """Test case for tax_rates_update + + Update Tax Rate # noqa: E501 + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_accounting_customer.py b/src/test/test_accounting_customer.py new file mode 100644 index 0000000000..56ed1cc179 --- /dev/null +++ b/src/test/test_accounting_customer.py @@ -0,0 +1,49 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.address import Address +from apideck.model.bank_account import BankAccount +from apideck.model.currency import Currency +from apideck.model.email import Email +from apideck.model.linked_tax_rate import LinkedTaxRate +from apideck.model.phone_number import PhoneNumber +from apideck.model.website import Website +globals()['Address'] = Address +globals()['BankAccount'] = BankAccount +globals()['Currency'] = Currency +globals()['Email'] = Email +globals()['LinkedTaxRate'] = LinkedTaxRate +globals()['PhoneNumber'] = PhoneNumber +globals()['Website'] = Website +from apideck.model.accounting_customer import AccountingCustomer + + +class TestAccountingCustomer(unittest.TestCase): + """AccountingCustomer unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testAccountingCustomer(self): + """Test AccountingCustomer""" + # FIXME: construct object with mandatory attributes with example values + # model = AccountingCustomer() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_accounting_event_type.py b/src/test/test_accounting_event_type.py new file mode 100644 index 0000000000..228f69e24a --- /dev/null +++ b/src/test/test_accounting_event_type.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.accounting_event_type import AccountingEventType + + +class TestAccountingEventType(unittest.TestCase): + """AccountingEventType unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testAccountingEventType(self): + """Test AccountingEventType""" + # FIXME: construct object with mandatory attributes with example values + # model = AccountingEventType() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_activity.py b/src/test/test_activity.py new file mode 100644 index 0000000000..f4ac5320e1 --- /dev/null +++ b/src/test/test_activity.py @@ -0,0 +1,41 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.activity_attendee import ActivityAttendee +from apideck.model.address import Address +from apideck.model.custom_field import CustomField +globals()['ActivityAttendee'] = ActivityAttendee +globals()['Address'] = Address +globals()['CustomField'] = CustomField +from apideck.model.activity import Activity + + +class TestActivity(unittest.TestCase): + """Activity unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testActivity(self): + """Test Activity""" + # FIXME: construct object with mandatory attributes with example values + # model = Activity() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_activity_attendee.py b/src/test/test_activity_attendee.py new file mode 100644 index 0000000000..37ec7164f5 --- /dev/null +++ b/src/test/test_activity_attendee.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.activity_attendee import ActivityAttendee + + +class TestActivityAttendee(unittest.TestCase): + """ActivityAttendee unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testActivityAttendee(self): + """Test ActivityAttendee""" + # FIXME: construct object with mandatory attributes with example values + # model = ActivityAttendee() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_address.py b/src/test/test_address.py new file mode 100644 index 0000000000..d010802e0d --- /dev/null +++ b/src/test/test_address.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.address import Address + + +class TestAddress(unittest.TestCase): + """Address unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testAddress(self): + """Test Address""" + # FIXME: construct object with mandatory attributes with example values + # model = Address() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_api.py b/src/test/test_api.py new file mode 100644 index 0000000000..c690383911 --- /dev/null +++ b/src/test/test_api.py @@ -0,0 +1,39 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.api_resources import ApiResources +from apideck.model.api_status import ApiStatus +globals()['ApiResources'] = ApiResources +globals()['ApiStatus'] = ApiStatus +from apideck.model.api import Api + + +class TestApi(unittest.TestCase): + """Api unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testApi(self): + """Test Api""" + # FIXME: construct object with mandatory attributes with example values + # model = Api() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_api_resource.py b/src/test/test_api_resource.py new file mode 100644 index 0000000000..feb435bda0 --- /dev/null +++ b/src/test/test_api_resource.py @@ -0,0 +1,39 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.api_resource_linked_resources import ApiResourceLinkedResources +from apideck.model.resource_status import ResourceStatus +globals()['ApiResourceLinkedResources'] = ApiResourceLinkedResources +globals()['ResourceStatus'] = ResourceStatus +from apideck.model.api_resource import ApiResource + + +class TestApiResource(unittest.TestCase): + """ApiResource unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testApiResource(self): + """Test ApiResource""" + # FIXME: construct object with mandatory attributes with example values + # model = ApiResource() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_api_resource_coverage.py b/src/test/test_api_resource_coverage.py new file mode 100644 index 0000000000..d686f90bae --- /dev/null +++ b/src/test/test_api_resource_coverage.py @@ -0,0 +1,39 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.api_resource_coverage_coverage import ApiResourceCoverageCoverage +from apideck.model.resource_status import ResourceStatus +globals()['ApiResourceCoverageCoverage'] = ApiResourceCoverageCoverage +globals()['ResourceStatus'] = ResourceStatus +from apideck.model.api_resource_coverage import ApiResourceCoverage + + +class TestApiResourceCoverage(unittest.TestCase): + """ApiResourceCoverage unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testApiResourceCoverage(self): + """Test ApiResourceCoverage""" + # FIXME: construct object with mandatory attributes with example values + # model = ApiResourceCoverage() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_api_resource_coverage_coverage.py b/src/test/test_api_resource_coverage_coverage.py new file mode 100644 index 0000000000..c96357df27 --- /dev/null +++ b/src/test/test_api_resource_coverage_coverage.py @@ -0,0 +1,39 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.pagination_coverage import PaginationCoverage +from apideck.model.supported_property import SupportedProperty +globals()['PaginationCoverage'] = PaginationCoverage +globals()['SupportedProperty'] = SupportedProperty +from apideck.model.api_resource_coverage_coverage import ApiResourceCoverageCoverage + + +class TestApiResourceCoverageCoverage(unittest.TestCase): + """ApiResourceCoverageCoverage unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testApiResourceCoverageCoverage(self): + """Test ApiResourceCoverageCoverage""" + # FIXME: construct object with mandatory attributes with example values + # model = ApiResourceCoverageCoverage() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_api_resource_linked_resources.py b/src/test/test_api_resource_linked_resources.py new file mode 100644 index 0000000000..5820cd4374 --- /dev/null +++ b/src/test/test_api_resource_linked_resources.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.api_resource_linked_resources import ApiResourceLinkedResources + + +class TestApiResourceLinkedResources(unittest.TestCase): + """ApiResourceLinkedResources unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testApiResourceLinkedResources(self): + """Test ApiResourceLinkedResources""" + # FIXME: construct object with mandatory attributes with example values + # model = ApiResourceLinkedResources() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_api_resources.py b/src/test/test_api_resources.py new file mode 100644 index 0000000000..81135652c3 --- /dev/null +++ b/src/test/test_api_resources.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.resource_status import ResourceStatus +globals()['ResourceStatus'] = ResourceStatus +from apideck.model.api_resources import ApiResources + + +class TestApiResources(unittest.TestCase): + """ApiResources unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testApiResources(self): + """Test ApiResources""" + # FIXME: construct object with mandatory attributes with example values + # model = ApiResources() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_api_status.py b/src/test/test_api_status.py new file mode 100644 index 0000000000..458a9b4efe --- /dev/null +++ b/src/test/test_api_status.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.api_status import ApiStatus + + +class TestApiStatus(unittest.TestCase): + """ApiStatus unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testApiStatus(self): + """Test ApiStatus""" + # FIXME: construct object with mandatory attributes with example values + # model = ApiStatus() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_apis_filter.py b/src/test/test_apis_filter.py new file mode 100644 index 0000000000..e45dbd3cac --- /dev/null +++ b/src/test/test_apis_filter.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.api_status import ApiStatus +globals()['ApiStatus'] = ApiStatus +from apideck.model.apis_filter import ApisFilter + + +class TestApisFilter(unittest.TestCase): + """ApisFilter unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testApisFilter(self): + """Test ApisFilter""" + # FIXME: construct object with mandatory attributes with example values + # model = ApisFilter() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_applicant.py b/src/test/test_applicant.py new file mode 100644 index 0000000000..7ff87ebb03 --- /dev/null +++ b/src/test/test_applicant.py @@ -0,0 +1,47 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.address import Address +from apideck.model.applicant_social_links import ApplicantSocialLinks +from apideck.model.applicant_websites import ApplicantWebsites +from apideck.model.email import Email +from apideck.model.phone_number import PhoneNumber +from apideck.model.tags import Tags +globals()['Address'] = Address +globals()['ApplicantSocialLinks'] = ApplicantSocialLinks +globals()['ApplicantWebsites'] = ApplicantWebsites +globals()['Email'] = Email +globals()['PhoneNumber'] = PhoneNumber +globals()['Tags'] = Tags +from apideck.model.applicant import Applicant + + +class TestApplicant(unittest.TestCase): + """Applicant unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testApplicant(self): + """Test Applicant""" + # FIXME: construct object with mandatory attributes with example values + # model = Applicant() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_applicant_social_links.py b/src/test/test_applicant_social_links.py new file mode 100644 index 0000000000..5e834ad988 --- /dev/null +++ b/src/test/test_applicant_social_links.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.applicant_social_links import ApplicantSocialLinks + + +class TestApplicantSocialLinks(unittest.TestCase): + """ApplicantSocialLinks unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testApplicantSocialLinks(self): + """Test ApplicantSocialLinks""" + # FIXME: construct object with mandatory attributes with example values + # model = ApplicantSocialLinks() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_applicant_websites.py b/src/test/test_applicant_websites.py new file mode 100644 index 0000000000..22db0d85af --- /dev/null +++ b/src/test/test_applicant_websites.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.applicant_websites import ApplicantWebsites + + +class TestApplicantWebsites(unittest.TestCase): + """ApplicantWebsites unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testApplicantWebsites(self): + """Test ApplicantWebsites""" + # FIXME: construct object with mandatory attributes with example values + # model = ApplicantWebsites() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_applicants_filter.py b/src/test/test_applicants_filter.py new file mode 100644 index 0000000000..a9981452ba --- /dev/null +++ b/src/test/test_applicants_filter.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.applicants_filter import ApplicantsFilter + + +class TestApplicantsFilter(unittest.TestCase): + """ApplicantsFilter unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testApplicantsFilter(self): + """Test ApplicantsFilter""" + # FIXME: construct object with mandatory attributes with example values + # model = ApplicantsFilter() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_ats_activity.py b/src/test/test_ats_activity.py new file mode 100644 index 0000000000..d01dc6d7e0 --- /dev/null +++ b/src/test/test_ats_activity.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.ats_activity import AtsActivity + + +class TestAtsActivity(unittest.TestCase): + """AtsActivity unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testAtsActivity(self): + """Test AtsActivity""" + # FIXME: construct object with mandatory attributes with example values + # model = AtsActivity() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_ats_api.py b/src/test/test_ats_api.py new file mode 100644 index 0000000000..6f5941af2f --- /dev/null +++ b/src/test/test_ats_api.py @@ -0,0 +1,63 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import apideck +from apideck.api.ats_api import AtsApi # noqa: E501 + + +class TestAtsApi(unittest.TestCase): + """AtsApi unit test stubs""" + + def setUp(self): + self.api = AtsApi() # noqa: E501 + + def tearDown(self): + pass + + def test_applicants_add(self): + """Test case for applicants_add + + Create applicant # noqa: E501 + """ + pass + + def test_applicants_all(self): + """Test case for applicants_all + + List applicants # noqa: E501 + """ + pass + + def test_applicants_one(self): + """Test case for applicants_one + + Get applicant # noqa: E501 + """ + pass + + def test_jobs_all(self): + """Test case for jobs_all + + List Jobs # noqa: E501 + """ + pass + + def test_jobs_one(self): + """Test case for jobs_one + + Get Job # noqa: E501 + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_ats_event_type.py b/src/test/test_ats_event_type.py new file mode 100644 index 0000000000..edaede54eb --- /dev/null +++ b/src/test/test_ats_event_type.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.ats_event_type import AtsEventType + + +class TestAtsEventType(unittest.TestCase): + """AtsEventType unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testAtsEventType(self): + """Test AtsEventType""" + # FIXME: construct object with mandatory attributes with example values + # model = AtsEventType() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_auth_type.py b/src/test/test_auth_type.py new file mode 100644 index 0000000000..3d977c25aa --- /dev/null +++ b/src/test/test_auth_type.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.auth_type import AuthType + + +class TestAuthType(unittest.TestCase): + """AuthType unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testAuthType(self): + """Test AuthType""" + # FIXME: construct object with mandatory attributes with example values + # model = AuthType() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_bad_request_response.py b/src/test/test_bad_request_response.py new file mode 100644 index 0000000000..3970844714 --- /dev/null +++ b/src/test/test_bad_request_response.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.bad_request_response import BadRequestResponse + + +class TestBadRequestResponse(unittest.TestCase): + """BadRequestResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testBadRequestResponse(self): + """Test BadRequestResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = BadRequestResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_balance_sheet.py b/src/test/test_balance_sheet.py new file mode 100644 index 0000000000..339045ec60 --- /dev/null +++ b/src/test/test_balance_sheet.py @@ -0,0 +1,41 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.balance_sheet_assets import BalanceSheetAssets +from apideck.model.balance_sheet_equity import BalanceSheetEquity +from apideck.model.balance_sheet_liabilities import BalanceSheetLiabilities +globals()['BalanceSheetAssets'] = BalanceSheetAssets +globals()['BalanceSheetEquity'] = BalanceSheetEquity +globals()['BalanceSheetLiabilities'] = BalanceSheetLiabilities +from apideck.model.balance_sheet import BalanceSheet + + +class TestBalanceSheet(unittest.TestCase): + """BalanceSheet unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testBalanceSheet(self): + """Test BalanceSheet""" + # FIXME: construct object with mandatory attributes with example values + # model = BalanceSheet() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_balance_sheet_assets.py b/src/test/test_balance_sheet_assets.py new file mode 100644 index 0000000000..d3e52ccd10 --- /dev/null +++ b/src/test/test_balance_sheet_assets.py @@ -0,0 +1,39 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.balance_sheet_assets_current_assets import BalanceSheetAssetsCurrentAssets +from apideck.model.balance_sheet_assets_fixed_assets import BalanceSheetAssetsFixedAssets +globals()['BalanceSheetAssetsCurrentAssets'] = BalanceSheetAssetsCurrentAssets +globals()['BalanceSheetAssetsFixedAssets'] = BalanceSheetAssetsFixedAssets +from apideck.model.balance_sheet_assets import BalanceSheetAssets + + +class TestBalanceSheetAssets(unittest.TestCase): + """BalanceSheetAssets unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testBalanceSheetAssets(self): + """Test BalanceSheetAssets""" + # FIXME: construct object with mandatory attributes with example values + # model = BalanceSheetAssets() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_balance_sheet_assets_current_assets.py b/src/test/test_balance_sheet_assets_current_assets.py new file mode 100644 index 0000000000..d40a929ae8 --- /dev/null +++ b/src/test/test_balance_sheet_assets_current_assets.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.balance_sheet_assets_current_assets_accounts import BalanceSheetAssetsCurrentAssetsAccounts +globals()['BalanceSheetAssetsCurrentAssetsAccounts'] = BalanceSheetAssetsCurrentAssetsAccounts +from apideck.model.balance_sheet_assets_current_assets import BalanceSheetAssetsCurrentAssets + + +class TestBalanceSheetAssetsCurrentAssets(unittest.TestCase): + """BalanceSheetAssetsCurrentAssets unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testBalanceSheetAssetsCurrentAssets(self): + """Test BalanceSheetAssetsCurrentAssets""" + # FIXME: construct object with mandatory attributes with example values + # model = BalanceSheetAssetsCurrentAssets() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_balance_sheet_assets_current_assets_accounts.py b/src/test/test_balance_sheet_assets_current_assets_accounts.py new file mode 100644 index 0000000000..e90a047510 --- /dev/null +++ b/src/test/test_balance_sheet_assets_current_assets_accounts.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.balance_sheet_assets_current_assets_accounts import BalanceSheetAssetsCurrentAssetsAccounts + + +class TestBalanceSheetAssetsCurrentAssetsAccounts(unittest.TestCase): + """BalanceSheetAssetsCurrentAssetsAccounts unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testBalanceSheetAssetsCurrentAssetsAccounts(self): + """Test BalanceSheetAssetsCurrentAssetsAccounts""" + # FIXME: construct object with mandatory attributes with example values + # model = BalanceSheetAssetsCurrentAssetsAccounts() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_balance_sheet_assets_fixed_assets.py b/src/test/test_balance_sheet_assets_fixed_assets.py new file mode 100644 index 0000000000..36687c3fd3 --- /dev/null +++ b/src/test/test_balance_sheet_assets_fixed_assets.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.balance_sheet_assets_fixed_assets_accounts import BalanceSheetAssetsFixedAssetsAccounts +globals()['BalanceSheetAssetsFixedAssetsAccounts'] = BalanceSheetAssetsFixedAssetsAccounts +from apideck.model.balance_sheet_assets_fixed_assets import BalanceSheetAssetsFixedAssets + + +class TestBalanceSheetAssetsFixedAssets(unittest.TestCase): + """BalanceSheetAssetsFixedAssets unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testBalanceSheetAssetsFixedAssets(self): + """Test BalanceSheetAssetsFixedAssets""" + # FIXME: construct object with mandatory attributes with example values + # model = BalanceSheetAssetsFixedAssets() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_balance_sheet_assets_fixed_assets_accounts.py b/src/test/test_balance_sheet_assets_fixed_assets_accounts.py new file mode 100644 index 0000000000..c9ad34cb8e --- /dev/null +++ b/src/test/test_balance_sheet_assets_fixed_assets_accounts.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.balance_sheet_assets_fixed_assets_accounts import BalanceSheetAssetsFixedAssetsAccounts + + +class TestBalanceSheetAssetsFixedAssetsAccounts(unittest.TestCase): + """BalanceSheetAssetsFixedAssetsAccounts unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testBalanceSheetAssetsFixedAssetsAccounts(self): + """Test BalanceSheetAssetsFixedAssetsAccounts""" + # FIXME: construct object with mandatory attributes with example values + # model = BalanceSheetAssetsFixedAssetsAccounts() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_balance_sheet_equity.py b/src/test/test_balance_sheet_equity.py new file mode 100644 index 0000000000..202c70ded2 --- /dev/null +++ b/src/test/test_balance_sheet_equity.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.balance_sheet_equity_items import BalanceSheetEquityItems +globals()['BalanceSheetEquityItems'] = BalanceSheetEquityItems +from apideck.model.balance_sheet_equity import BalanceSheetEquity + + +class TestBalanceSheetEquity(unittest.TestCase): + """BalanceSheetEquity unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testBalanceSheetEquity(self): + """Test BalanceSheetEquity""" + # FIXME: construct object with mandatory attributes with example values + # model = BalanceSheetEquity() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_balance_sheet_equity_items.py b/src/test/test_balance_sheet_equity_items.py new file mode 100644 index 0000000000..b4339fb393 --- /dev/null +++ b/src/test/test_balance_sheet_equity_items.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.balance_sheet_equity_items import BalanceSheetEquityItems + + +class TestBalanceSheetEquityItems(unittest.TestCase): + """BalanceSheetEquityItems unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testBalanceSheetEquityItems(self): + """Test BalanceSheetEquityItems""" + # FIXME: construct object with mandatory attributes with example values + # model = BalanceSheetEquityItems() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_balance_sheet_filter.py b/src/test/test_balance_sheet_filter.py new file mode 100644 index 0000000000..232e59fcd6 --- /dev/null +++ b/src/test/test_balance_sheet_filter.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.balance_sheet_filter import BalanceSheetFilter + + +class TestBalanceSheetFilter(unittest.TestCase): + """BalanceSheetFilter unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testBalanceSheetFilter(self): + """Test BalanceSheetFilter""" + # FIXME: construct object with mandatory attributes with example values + # model = BalanceSheetFilter() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_balance_sheet_liabilities.py b/src/test/test_balance_sheet_liabilities.py new file mode 100644 index 0000000000..4acaacef47 --- /dev/null +++ b/src/test/test_balance_sheet_liabilities.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.balance_sheet_liabilities_accounts import BalanceSheetLiabilitiesAccounts +globals()['BalanceSheetLiabilitiesAccounts'] = BalanceSheetLiabilitiesAccounts +from apideck.model.balance_sheet_liabilities import BalanceSheetLiabilities + + +class TestBalanceSheetLiabilities(unittest.TestCase): + """BalanceSheetLiabilities unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testBalanceSheetLiabilities(self): + """Test BalanceSheetLiabilities""" + # FIXME: construct object with mandatory attributes with example values + # model = BalanceSheetLiabilities() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_balance_sheet_liabilities_accounts.py b/src/test/test_balance_sheet_liabilities_accounts.py new file mode 100644 index 0000000000..753faa9825 --- /dev/null +++ b/src/test/test_balance_sheet_liabilities_accounts.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.balance_sheet_liabilities_accounts import BalanceSheetLiabilitiesAccounts + + +class TestBalanceSheetLiabilitiesAccounts(unittest.TestCase): + """BalanceSheetLiabilitiesAccounts unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testBalanceSheetLiabilitiesAccounts(self): + """Test BalanceSheetLiabilitiesAccounts""" + # FIXME: construct object with mandatory attributes with example values + # model = BalanceSheetLiabilitiesAccounts() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_bank_account.py b/src/test/test_bank_account.py new file mode 100644 index 0000000000..2f48e29fb7 --- /dev/null +++ b/src/test/test_bank_account.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.currency import Currency +globals()['Currency'] = Currency +from apideck.model.bank_account import BankAccount + + +class TestBankAccount(unittest.TestCase): + """BankAccount unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testBankAccount(self): + """Test BankAccount""" + # FIXME: construct object with mandatory attributes with example values + # model = BankAccount() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_benefit.py b/src/test/test_benefit.py new file mode 100644 index 0000000000..56d83337c6 --- /dev/null +++ b/src/test/test_benefit.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.benefit import Benefit + + +class TestBenefit(unittest.TestCase): + """Benefit unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testBenefit(self): + """Test Benefit""" + # FIXME: construct object with mandatory attributes with example values + # model = Benefit() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_bill.py b/src/test/test_bill.py new file mode 100644 index 0000000000..79c9b314bd --- /dev/null +++ b/src/test/test_bill.py @@ -0,0 +1,43 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.bill_line_item import BillLineItem +from apideck.model.currency import Currency +from apideck.model.linked_ledger_account import LinkedLedgerAccount +from apideck.model.linked_supplier import LinkedSupplier +globals()['BillLineItem'] = BillLineItem +globals()['Currency'] = Currency +globals()['LinkedLedgerAccount'] = LinkedLedgerAccount +globals()['LinkedSupplier'] = LinkedSupplier +from apideck.model.bill import Bill + + +class TestBill(unittest.TestCase): + """Bill unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testBill(self): + """Test Bill""" + # FIXME: construct object with mandatory attributes with example values + # model = Bill() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_bill_line_item.py b/src/test/test_bill_line_item.py new file mode 100644 index 0000000000..2f152ca25a --- /dev/null +++ b/src/test/test_bill_line_item.py @@ -0,0 +1,41 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.linked_invoice_item import LinkedInvoiceItem +from apideck.model.linked_ledger_account import LinkedLedgerAccount +from apideck.model.linked_tax_rate import LinkedTaxRate +globals()['LinkedInvoiceItem'] = LinkedInvoiceItem +globals()['LinkedLedgerAccount'] = LinkedLedgerAccount +globals()['LinkedTaxRate'] = LinkedTaxRate +from apideck.model.bill_line_item import BillLineItem + + +class TestBillLineItem(unittest.TestCase): + """BillLineItem unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testBillLineItem(self): + """Test BillLineItem""" + # FIXME: construct object with mandatory attributes with example values + # model = BillLineItem() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_branch.py b/src/test/test_branch.py new file mode 100644 index 0000000000..50c31bc18b --- /dev/null +++ b/src/test/test_branch.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.branch import Branch + + +class TestBranch(unittest.TestCase): + """Branch unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testBranch(self): + """Test Branch""" + # FIXME: construct object with mandatory attributes with example values + # model = Branch() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_cash_details.py b/src/test/test_cash_details.py new file mode 100644 index 0000000000..266b8a93c1 --- /dev/null +++ b/src/test/test_cash_details.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.cash_details import CashDetails + + +class TestCashDetails(unittest.TestCase): + """CashDetails unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testCashDetails(self): + """Test CashDetails""" + # FIXME: construct object with mandatory attributes with example values + # model = CashDetails() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_companies_filter.py b/src/test/test_companies_filter.py new file mode 100644 index 0000000000..ad6805e65a --- /dev/null +++ b/src/test/test_companies_filter.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.companies_filter import CompaniesFilter + + +class TestCompaniesFilter(unittest.TestCase): + """CompaniesFilter unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testCompaniesFilter(self): + """Test CompaniesFilter""" + # FIXME: construct object with mandatory attributes with example values + # model = CompaniesFilter() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_companies_sort.py b/src/test/test_companies_sort.py new file mode 100644 index 0000000000..3157f15267 --- /dev/null +++ b/src/test/test_companies_sort.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.sort_direction import SortDirection +globals()['SortDirection'] = SortDirection +from apideck.model.companies_sort import CompaniesSort + + +class TestCompaniesSort(unittest.TestCase): + """CompaniesSort unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testCompaniesSort(self): + """Test CompaniesSort""" + # FIXME: construct object with mandatory attributes with example values + # model = CompaniesSort() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_company.py b/src/test/test_company.py new file mode 100644 index 0000000000..1818f05798 --- /dev/null +++ b/src/test/test_company.py @@ -0,0 +1,55 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.address import Address +from apideck.model.bank_account import BankAccount +from apideck.model.company_row_type import CompanyRowType +from apideck.model.currency import Currency +from apideck.model.custom_field import CustomField +from apideck.model.email import Email +from apideck.model.phone_number import PhoneNumber +from apideck.model.social_link import SocialLink +from apideck.model.tags import Tags +from apideck.model.website import Website +globals()['Address'] = Address +globals()['BankAccount'] = BankAccount +globals()['CompanyRowType'] = CompanyRowType +globals()['Currency'] = Currency +globals()['CustomField'] = CustomField +globals()['Email'] = Email +globals()['PhoneNumber'] = PhoneNumber +globals()['SocialLink'] = SocialLink +globals()['Tags'] = Tags +globals()['Website'] = Website +from apideck.model.company import Company + + +class TestCompany(unittest.TestCase): + """Company unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testCompany(self): + """Test Company""" + # FIXME: construct object with mandatory attributes with example values + # model = Company() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_company_info.py b/src/test/test_company_info.py new file mode 100644 index 0000000000..c89eff4a16 --- /dev/null +++ b/src/test/test_company_info.py @@ -0,0 +1,45 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.address import Address +from apideck.model.currency import Currency +from apideck.model.email import Email +from apideck.model.linked_tax_rate import LinkedTaxRate +from apideck.model.phone_number import PhoneNumber +globals()['Address'] = Address +globals()['Currency'] = Currency +globals()['Email'] = Email +globals()['LinkedTaxRate'] = LinkedTaxRate +globals()['PhoneNumber'] = PhoneNumber +from apideck.model.company_info import CompanyInfo + + +class TestCompanyInfo(unittest.TestCase): + """CompanyInfo unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testCompanyInfo(self): + """Test CompanyInfo""" + # FIXME: construct object with mandatory attributes with example values + # model = CompanyInfo() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_company_row_type.py b/src/test/test_company_row_type.py new file mode 100644 index 0000000000..9496880dc5 --- /dev/null +++ b/src/test/test_company_row_type.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.company_row_type import CompanyRowType + + +class TestCompanyRowType(unittest.TestCase): + """CompanyRowType unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testCompanyRowType(self): + """Test CompanyRowType""" + # FIXME: construct object with mandatory attributes with example values + # model = CompanyRowType() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_compensation.py b/src/test/test_compensation.py new file mode 100644 index 0000000000..5ca2b28010 --- /dev/null +++ b/src/test/test_compensation.py @@ -0,0 +1,41 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.benefit import Benefit +from apideck.model.deduction import Deduction +from apideck.model.tax import Tax +globals()['Benefit'] = Benefit +globals()['Deduction'] = Deduction +globals()['Tax'] = Tax +from apideck.model.compensation import Compensation + + +class TestCompensation(unittest.TestCase): + """Compensation unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testCompensation(self): + """Test Compensation""" + # FIXME: construct object with mandatory attributes with example values + # model = Compensation() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_connection.py b/src/test/test_connection.py new file mode 100644 index 0000000000..66fef90b0f --- /dev/null +++ b/src/test/test_connection.py @@ -0,0 +1,47 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.auth_type import AuthType +from apideck.model.connection_configuration import ConnectionConfiguration +from apideck.model.connection_state import ConnectionState +from apideck.model.form_field import FormField +from apideck.model.o_auth_grant_type import OAuthGrantType +from apideck.model.webhook_subscription import WebhookSubscription +globals()['AuthType'] = AuthType +globals()['ConnectionConfiguration'] = ConnectionConfiguration +globals()['ConnectionState'] = ConnectionState +globals()['FormField'] = FormField +globals()['OAuthGrantType'] = OAuthGrantType +globals()['WebhookSubscription'] = WebhookSubscription +from apideck.model.connection import Connection + + +class TestConnection(unittest.TestCase): + """Connection unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testConnection(self): + """Test Connection""" + # FIXME: construct object with mandatory attributes with example values + # model = Connection() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_connection_configuration.py b/src/test/test_connection_configuration.py new file mode 100644 index 0000000000..d39f8185b0 --- /dev/null +++ b/src/test/test_connection_configuration.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.connection_defaults import ConnectionDefaults +globals()['ConnectionDefaults'] = ConnectionDefaults +from apideck.model.connection_configuration import ConnectionConfiguration + + +class TestConnectionConfiguration(unittest.TestCase): + """ConnectionConfiguration unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testConnectionConfiguration(self): + """Test ConnectionConfiguration""" + # FIXME: construct object with mandatory attributes with example values + # model = ConnectionConfiguration() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_connection_defaults.py b/src/test/test_connection_defaults.py new file mode 100644 index 0000000000..60ae72b828 --- /dev/null +++ b/src/test/test_connection_defaults.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.form_field_option import FormFieldOption +globals()['FormFieldOption'] = FormFieldOption +from apideck.model.connection_defaults import ConnectionDefaults + + +class TestConnectionDefaults(unittest.TestCase): + """ConnectionDefaults unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testConnectionDefaults(self): + """Test ConnectionDefaults""" + # FIXME: construct object with mandatory attributes with example values + # model = ConnectionDefaults() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_connection_import_data.py b/src/test/test_connection_import_data.py new file mode 100644 index 0000000000..c5085a8d73 --- /dev/null +++ b/src/test/test_connection_import_data.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.connection_import_data_credentials import ConnectionImportDataCredentials +globals()['ConnectionImportDataCredentials'] = ConnectionImportDataCredentials +from apideck.model.connection_import_data import ConnectionImportData + + +class TestConnectionImportData(unittest.TestCase): + """ConnectionImportData unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testConnectionImportData(self): + """Test ConnectionImportData""" + # FIXME: construct object with mandatory attributes with example values + # model = ConnectionImportData() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_connection_import_data_credentials.py b/src/test/test_connection_import_data_credentials.py new file mode 100644 index 0000000000..e042689b5d --- /dev/null +++ b/src/test/test_connection_import_data_credentials.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.connection_import_data_credentials import ConnectionImportDataCredentials + + +class TestConnectionImportDataCredentials(unittest.TestCase): + """ConnectionImportDataCredentials unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testConnectionImportDataCredentials(self): + """Test ConnectionImportDataCredentials""" + # FIXME: construct object with mandatory attributes with example values + # model = ConnectionImportDataCredentials() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_connection_metadata.py b/src/test/test_connection_metadata.py new file mode 100644 index 0000000000..dbbc65e8f7 --- /dev/null +++ b/src/test/test_connection_metadata.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.connection_metadata import ConnectionMetadata + + +class TestConnectionMetadata(unittest.TestCase): + """ConnectionMetadata unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testConnectionMetadata(self): + """Test ConnectionMetadata""" + # FIXME: construct object with mandatory attributes with example values + # model = ConnectionMetadata() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_connection_state.py b/src/test/test_connection_state.py new file mode 100644 index 0000000000..5d24fc12c9 --- /dev/null +++ b/src/test/test_connection_state.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.connection_state import ConnectionState + + +class TestConnectionState(unittest.TestCase): + """ConnectionState unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testConnectionState(self): + """Test ConnectionState""" + # FIXME: construct object with mandatory attributes with example values + # model = ConnectionState() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_connection_webhook.py b/src/test/test_connection_webhook.py new file mode 100644 index 0000000000..4887dce937 --- /dev/null +++ b/src/test/test_connection_webhook.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_api_id import UnifiedApiId +globals()['UnifiedApiId'] = UnifiedApiId +from apideck.model.connection_webhook import ConnectionWebhook + + +class TestConnectionWebhook(unittest.TestCase): + """ConnectionWebhook unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testConnectionWebhook(self): + """Test ConnectionWebhook""" + # FIXME: construct object with mandatory attributes with example values + # model = ConnectionWebhook() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_connector.py b/src/test/test_connector.py new file mode 100644 index 0000000000..7453a499a9 --- /dev/null +++ b/src/test/test_connector.py @@ -0,0 +1,53 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.connector_doc import ConnectorDoc +from apideck.model.connector_event import ConnectorEvent +from apideck.model.connector_oauth_scopes import ConnectorOauthScopes +from apideck.model.connector_setting import ConnectorSetting +from apideck.model.connector_status import ConnectorStatus +from apideck.model.connector_tls_support import ConnectorTlsSupport +from apideck.model.connector_unified_apis import ConnectorUnifiedApis +from apideck.model.linked_connector_resource import LinkedConnectorResource +from apideck.model.webhook_support import WebhookSupport +globals()['ConnectorDoc'] = ConnectorDoc +globals()['ConnectorEvent'] = ConnectorEvent +globals()['ConnectorOauthScopes'] = ConnectorOauthScopes +globals()['ConnectorSetting'] = ConnectorSetting +globals()['ConnectorStatus'] = ConnectorStatus +globals()['ConnectorTlsSupport'] = ConnectorTlsSupport +globals()['ConnectorUnifiedApis'] = ConnectorUnifiedApis +globals()['LinkedConnectorResource'] = LinkedConnectorResource +globals()['WebhookSupport'] = WebhookSupport +from apideck.model.connector import Connector + + +class TestConnector(unittest.TestCase): + """Connector unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testConnector(self): + """Test Connector""" + # FIXME: construct object with mandatory attributes with example values + # model = Connector() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_connector_api.py b/src/test/test_connector_api.py new file mode 100644 index 0000000000..382911655d --- /dev/null +++ b/src/test/test_connector_api.py @@ -0,0 +1,84 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import apideck +from apideck.api.connector_api import ConnectorApi # noqa: E501 + + +class TestConnectorApi(unittest.TestCase): + """ConnectorApi unit test stubs""" + + def setUp(self): + self.api = ConnectorApi() # noqa: E501 + + def tearDown(self): + pass + + def test_api_resource_coverage_one(self): + """Test case for api_resource_coverage_one + + Get API Resource Coverage # noqa: E501 + """ + pass + + def test_api_resources_one(self): + """Test case for api_resources_one + + Get API Resource # noqa: E501 + """ + pass + + def test_apis_all(self): + """Test case for apis_all + + List APIs # noqa: E501 + """ + pass + + def test_apis_one(self): + """Test case for apis_one + + Get API # noqa: E501 + """ + pass + + def test_connector_docs_one(self): + """Test case for connector_docs_one + + Get Connector Doc content # noqa: E501 + """ + pass + + def test_connector_resources_one(self): + """Test case for connector_resources_one + + Get Connector Resource # noqa: E501 + """ + pass + + def test_connectors_all(self): + """Test case for connectors_all + + List Connectors # noqa: E501 + """ + pass + + def test_connectors_one(self): + """Test case for connectors_one + + Get Connector # noqa: E501 + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_connector_doc.py b/src/test/test_connector_doc.py new file mode 100644 index 0000000000..e8d03e9534 --- /dev/null +++ b/src/test/test_connector_doc.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.connector_doc import ConnectorDoc + + +class TestConnectorDoc(unittest.TestCase): + """ConnectorDoc unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testConnectorDoc(self): + """Test ConnectorDoc""" + # FIXME: construct object with mandatory attributes with example values + # model = ConnectorDoc() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_connector_event.py b/src/test/test_connector_event.py new file mode 100644 index 0000000000..456e7251c2 --- /dev/null +++ b/src/test/test_connector_event.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.connector_event import ConnectorEvent + + +class TestConnectorEvent(unittest.TestCase): + """ConnectorEvent unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testConnectorEvent(self): + """Test ConnectorEvent""" + # FIXME: construct object with mandatory attributes with example values + # model = ConnectorEvent() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_connector_oauth_scopes.py b/src/test/test_connector_oauth_scopes.py new file mode 100644 index 0000000000..220cd4f736 --- /dev/null +++ b/src/test/test_connector_oauth_scopes.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.connector_oauth_scopes import ConnectorOauthScopes + + +class TestConnectorOauthScopes(unittest.TestCase): + """ConnectorOauthScopes unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testConnectorOauthScopes(self): + """Test ConnectorOauthScopes""" + # FIXME: construct object with mandatory attributes with example values + # model = ConnectorOauthScopes() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_connector_oauth_scopes1.py b/src/test/test_connector_oauth_scopes1.py new file mode 100644 index 0000000000..21d9ecb21d --- /dev/null +++ b/src/test/test_connector_oauth_scopes1.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.connector_oauth_scopes1 import ConnectorOauthScopes1 + + +class TestConnectorOauthScopes1(unittest.TestCase): + """ConnectorOauthScopes1 unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testConnectorOauthScopes1(self): + """Test ConnectorOauthScopes1""" + # FIXME: construct object with mandatory attributes with example values + # model = ConnectorOauthScopes1() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_connector_resource.py b/src/test/test_connector_resource.py new file mode 100644 index 0000000000..6b22ec1935 --- /dev/null +++ b/src/test/test_connector_resource.py @@ -0,0 +1,41 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.pagination_coverage import PaginationCoverage +from apideck.model.resource_status import ResourceStatus +from apideck.model.supported_property import SupportedProperty +globals()['PaginationCoverage'] = PaginationCoverage +globals()['ResourceStatus'] = ResourceStatus +globals()['SupportedProperty'] = SupportedProperty +from apideck.model.connector_resource import ConnectorResource + + +class TestConnectorResource(unittest.TestCase): + """ConnectorResource unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testConnectorResource(self): + """Test ConnectorResource""" + # FIXME: construct object with mandatory attributes with example values + # model = ConnectorResource() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_connector_setting.py b/src/test/test_connector_setting.py new file mode 100644 index 0000000000..92538658bc --- /dev/null +++ b/src/test/test_connector_setting.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.connector_setting import ConnectorSetting + + +class TestConnectorSetting(unittest.TestCase): + """ConnectorSetting unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testConnectorSetting(self): + """Test ConnectorSetting""" + # FIXME: construct object with mandatory attributes with example values + # model = ConnectorSetting() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_connector_status.py b/src/test/test_connector_status.py new file mode 100644 index 0000000000..2b51e51d70 --- /dev/null +++ b/src/test/test_connector_status.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.connector_status import ConnectorStatus + + +class TestConnectorStatus(unittest.TestCase): + """ConnectorStatus unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testConnectorStatus(self): + """Test ConnectorStatus""" + # FIXME: construct object with mandatory attributes with example values + # model = ConnectorStatus() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_connector_tls_support.py b/src/test/test_connector_tls_support.py new file mode 100644 index 0000000000..4e4431b3dd --- /dev/null +++ b/src/test/test_connector_tls_support.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.connector_tls_support import ConnectorTlsSupport + + +class TestConnectorTlsSupport(unittest.TestCase): + """ConnectorTlsSupport unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testConnectorTlsSupport(self): + """Test ConnectorTlsSupport""" + # FIXME: construct object with mandatory attributes with example values + # model = ConnectorTlsSupport() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_connector_unified_apis.py b/src/test/test_connector_unified_apis.py new file mode 100644 index 0000000000..13e3118f9b --- /dev/null +++ b/src/test/test_connector_unified_apis.py @@ -0,0 +1,43 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.connector_event import ConnectorEvent +from apideck.model.connector_oauth_scopes1 import ConnectorOauthScopes1 +from apideck.model.linked_connector_resource import LinkedConnectorResource +from apideck.model.unified_api_id import UnifiedApiId +globals()['ConnectorEvent'] = ConnectorEvent +globals()['ConnectorOauthScopes1'] = ConnectorOauthScopes1 +globals()['LinkedConnectorResource'] = LinkedConnectorResource +globals()['UnifiedApiId'] = UnifiedApiId +from apideck.model.connector_unified_apis import ConnectorUnifiedApis + + +class TestConnectorUnifiedApis(unittest.TestCase): + """ConnectorUnifiedApis unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testConnectorUnifiedApis(self): + """Test ConnectorUnifiedApis""" + # FIXME: construct object with mandatory attributes with example values + # model = ConnectorUnifiedApis() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_connectors_filter.py b/src/test/test_connectors_filter.py new file mode 100644 index 0000000000..43fb6008af --- /dev/null +++ b/src/test/test_connectors_filter.py @@ -0,0 +1,39 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.connector_status import ConnectorStatus +from apideck.model.unified_api_id import UnifiedApiId +globals()['ConnectorStatus'] = ConnectorStatus +globals()['UnifiedApiId'] = UnifiedApiId +from apideck.model.connectors_filter import ConnectorsFilter + + +class TestConnectorsFilter(unittest.TestCase): + """ConnectorsFilter unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testConnectorsFilter(self): + """Test ConnectorsFilter""" + # FIXME: construct object with mandatory attributes with example values + # model = ConnectorsFilter() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_consumer.py b/src/test/test_consumer.py new file mode 100644 index 0000000000..614e7ef79e --- /dev/null +++ b/src/test/test_consumer.py @@ -0,0 +1,41 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.consumer_connection import ConsumerConnection +from apideck.model.consumer_metadata import ConsumerMetadata +from apideck.model.request_count_allocation import RequestCountAllocation +globals()['ConsumerConnection'] = ConsumerConnection +globals()['ConsumerMetadata'] = ConsumerMetadata +globals()['RequestCountAllocation'] = RequestCountAllocation +from apideck.model.consumer import Consumer + + +class TestConsumer(unittest.TestCase): + """Consumer unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testConsumer(self): + """Test Consumer""" + # FIXME: construct object with mandatory attributes with example values + # model = Consumer() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_consumer_connection.py b/src/test/test_consumer_connection.py new file mode 100644 index 0000000000..5bd89abb73 --- /dev/null +++ b/src/test/test_consumer_connection.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.auth_type import AuthType +globals()['AuthType'] = AuthType +from apideck.model.consumer_connection import ConsumerConnection + + +class TestConsumerConnection(unittest.TestCase): + """ConsumerConnection unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testConsumerConnection(self): + """Test ConsumerConnection""" + # FIXME: construct object with mandatory attributes with example values + # model = ConsumerConnection() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_consumer_metadata.py b/src/test/test_consumer_metadata.py new file mode 100644 index 0000000000..8e4145370d --- /dev/null +++ b/src/test/test_consumer_metadata.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.consumer_metadata import ConsumerMetadata + + +class TestConsumerMetadata(unittest.TestCase): + """ConsumerMetadata unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testConsumerMetadata(self): + """Test ConsumerMetadata""" + # FIXME: construct object with mandatory attributes with example values + # model = ConsumerMetadata() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_consumer_request_counts_in_date_range_response.py b/src/test/test_consumer_request_counts_in_date_range_response.py new file mode 100644 index 0000000000..b6ea913eb1 --- /dev/null +++ b/src/test/test_consumer_request_counts_in_date_range_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.consumer_request_counts_in_date_range_response_data import ConsumerRequestCountsInDateRangeResponseData +globals()['ConsumerRequestCountsInDateRangeResponseData'] = ConsumerRequestCountsInDateRangeResponseData +from apideck.model.consumer_request_counts_in_date_range_response import ConsumerRequestCountsInDateRangeResponse + + +class TestConsumerRequestCountsInDateRangeResponse(unittest.TestCase): + """ConsumerRequestCountsInDateRangeResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testConsumerRequestCountsInDateRangeResponse(self): + """Test ConsumerRequestCountsInDateRangeResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = ConsumerRequestCountsInDateRangeResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_consumer_request_counts_in_date_range_response_data.py b/src/test/test_consumer_request_counts_in_date_range_response_data.py new file mode 100644 index 0000000000..21c9540baf --- /dev/null +++ b/src/test/test_consumer_request_counts_in_date_range_response_data.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.request_count_allocation import RequestCountAllocation +globals()['RequestCountAllocation'] = RequestCountAllocation +from apideck.model.consumer_request_counts_in_date_range_response_data import ConsumerRequestCountsInDateRangeResponseData + + +class TestConsumerRequestCountsInDateRangeResponseData(unittest.TestCase): + """ConsumerRequestCountsInDateRangeResponseData unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testConsumerRequestCountsInDateRangeResponseData(self): + """Test ConsumerRequestCountsInDateRangeResponseData""" + # FIXME: construct object with mandatory attributes with example values + # model = ConsumerRequestCountsInDateRangeResponseData() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_contact.py b/src/test/test_contact.py new file mode 100644 index 0000000000..2d7e4d0309 --- /dev/null +++ b/src/test/test_contact.py @@ -0,0 +1,49 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.address import Address +from apideck.model.custom_field import CustomField +from apideck.model.email import Email +from apideck.model.phone_number import PhoneNumber +from apideck.model.social_link import SocialLink +from apideck.model.tags import Tags +from apideck.model.website import Website +globals()['Address'] = Address +globals()['CustomField'] = CustomField +globals()['Email'] = Email +globals()['PhoneNumber'] = PhoneNumber +globals()['SocialLink'] = SocialLink +globals()['Tags'] = Tags +globals()['Website'] = Website +from apideck.model.contact import Contact + + +class TestContact(unittest.TestCase): + """Contact unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testContact(self): + """Test Contact""" + # FIXME: construct object with mandatory attributes with example values + # model = Contact() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_contacts_filter.py b/src/test/test_contacts_filter.py new file mode 100644 index 0000000000..01e7899b3e --- /dev/null +++ b/src/test/test_contacts_filter.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.contacts_filter import ContactsFilter + + +class TestContactsFilter(unittest.TestCase): + """ContactsFilter unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testContactsFilter(self): + """Test ContactsFilter""" + # FIXME: construct object with mandatory attributes with example values + # model = ContactsFilter() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_contacts_sort.py b/src/test/test_contacts_sort.py new file mode 100644 index 0000000000..382384f789 --- /dev/null +++ b/src/test/test_contacts_sort.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.sort_direction import SortDirection +globals()['SortDirection'] = SortDirection +from apideck.model.contacts_sort import ContactsSort + + +class TestContactsSort(unittest.TestCase): + """ContactsSort unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testContactsSort(self): + """Test ContactsSort""" + # FIXME: construct object with mandatory attributes with example values + # model = ContactsSort() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_copy_folder_request.py b/src/test/test_copy_folder_request.py new file mode 100644 index 0000000000..08f50e3e39 --- /dev/null +++ b/src/test/test_copy_folder_request.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.copy_folder_request import CopyFolderRequest + + +class TestCopyFolderRequest(unittest.TestCase): + """CopyFolderRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testCopyFolderRequest(self): + """Test CopyFolderRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = CopyFolderRequest() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_create_activity_response.py b/src/test/test_create_activity_response.py new file mode 100644 index 0000000000..3485873162 --- /dev/null +++ b/src/test/test_create_activity_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId +globals()['UnifiedId'] = UnifiedId +from apideck.model.create_activity_response import CreateActivityResponse + + +class TestCreateActivityResponse(unittest.TestCase): + """CreateActivityResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testCreateActivityResponse(self): + """Test CreateActivityResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = CreateActivityResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_create_applicant_response.py b/src/test/test_create_applicant_response.py new file mode 100644 index 0000000000..9ffdee56a1 --- /dev/null +++ b/src/test/test_create_applicant_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId +globals()['UnifiedId'] = UnifiedId +from apideck.model.create_applicant_response import CreateApplicantResponse + + +class TestCreateApplicantResponse(unittest.TestCase): + """CreateApplicantResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testCreateApplicantResponse(self): + """Test CreateApplicantResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = CreateApplicantResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_create_bill_response.py b/src/test/test_create_bill_response.py new file mode 100644 index 0000000000..f4cb61f5e4 --- /dev/null +++ b/src/test/test_create_bill_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId +globals()['UnifiedId'] = UnifiedId +from apideck.model.create_bill_response import CreateBillResponse + + +class TestCreateBillResponse(unittest.TestCase): + """CreateBillResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testCreateBillResponse(self): + """Test CreateBillResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = CreateBillResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_create_company_response.py b/src/test/test_create_company_response.py new file mode 100644 index 0000000000..024cc8b067 --- /dev/null +++ b/src/test/test_create_company_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId +globals()['UnifiedId'] = UnifiedId +from apideck.model.create_company_response import CreateCompanyResponse + + +class TestCreateCompanyResponse(unittest.TestCase): + """CreateCompanyResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testCreateCompanyResponse(self): + """Test CreateCompanyResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = CreateCompanyResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_create_connection_response.py b/src/test/test_create_connection_response.py new file mode 100644 index 0000000000..b9a19c2322 --- /dev/null +++ b/src/test/test_create_connection_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.connection import Connection +globals()['Connection'] = Connection +from apideck.model.create_connection_response import CreateConnectionResponse + + +class TestCreateConnectionResponse(unittest.TestCase): + """CreateConnectionResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testCreateConnectionResponse(self): + """Test CreateConnectionResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = CreateConnectionResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_create_contact_response.py b/src/test/test_create_contact_response.py new file mode 100644 index 0000000000..9aa8c94eaf --- /dev/null +++ b/src/test/test_create_contact_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId +globals()['UnifiedId'] = UnifiedId +from apideck.model.create_contact_response import CreateContactResponse + + +class TestCreateContactResponse(unittest.TestCase): + """CreateContactResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testCreateContactResponse(self): + """Test CreateContactResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = CreateContactResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_create_credit_note_response.py b/src/test/test_create_credit_note_response.py new file mode 100644 index 0000000000..e16cb68679 --- /dev/null +++ b/src/test/test_create_credit_note_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId +globals()['UnifiedId'] = UnifiedId +from apideck.model.create_credit_note_response import CreateCreditNoteResponse + + +class TestCreateCreditNoteResponse(unittest.TestCase): + """CreateCreditNoteResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testCreateCreditNoteResponse(self): + """Test CreateCreditNoteResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = CreateCreditNoteResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_create_customer_response.py b/src/test/test_create_customer_response.py new file mode 100644 index 0000000000..a01002e05a --- /dev/null +++ b/src/test/test_create_customer_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId +globals()['UnifiedId'] = UnifiedId +from apideck.model.create_customer_response import CreateCustomerResponse + + +class TestCreateCustomerResponse(unittest.TestCase): + """CreateCustomerResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testCreateCustomerResponse(self): + """Test CreateCustomerResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = CreateCustomerResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_create_customer_support_customer_response.py b/src/test/test_create_customer_support_customer_response.py new file mode 100644 index 0000000000..5bddf601ae --- /dev/null +++ b/src/test/test_create_customer_support_customer_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId +globals()['UnifiedId'] = UnifiedId +from apideck.model.create_customer_support_customer_response import CreateCustomerSupportCustomerResponse + + +class TestCreateCustomerSupportCustomerResponse(unittest.TestCase): + """CreateCustomerSupportCustomerResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testCreateCustomerSupportCustomerResponse(self): + """Test CreateCustomerSupportCustomerResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = CreateCustomerSupportCustomerResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_create_department_response.py b/src/test/test_create_department_response.py new file mode 100644 index 0000000000..4390e4700e --- /dev/null +++ b/src/test/test_create_department_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId +globals()['UnifiedId'] = UnifiedId +from apideck.model.create_department_response import CreateDepartmentResponse + + +class TestCreateDepartmentResponse(unittest.TestCase): + """CreateDepartmentResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testCreateDepartmentResponse(self): + """Test CreateDepartmentResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = CreateDepartmentResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_create_drive_group_response.py b/src/test/test_create_drive_group_response.py new file mode 100644 index 0000000000..c558392606 --- /dev/null +++ b/src/test/test_create_drive_group_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId +globals()['UnifiedId'] = UnifiedId +from apideck.model.create_drive_group_response import CreateDriveGroupResponse + + +class TestCreateDriveGroupResponse(unittest.TestCase): + """CreateDriveGroupResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testCreateDriveGroupResponse(self): + """Test CreateDriveGroupResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = CreateDriveGroupResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_create_drive_response.py b/src/test/test_create_drive_response.py new file mode 100644 index 0000000000..046a1943f6 --- /dev/null +++ b/src/test/test_create_drive_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId +globals()['UnifiedId'] = UnifiedId +from apideck.model.create_drive_response import CreateDriveResponse + + +class TestCreateDriveResponse(unittest.TestCase): + """CreateDriveResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testCreateDriveResponse(self): + """Test CreateDriveResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = CreateDriveResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_create_employee_response.py b/src/test/test_create_employee_response.py new file mode 100644 index 0000000000..8f5a0e89e0 --- /dev/null +++ b/src/test/test_create_employee_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId +globals()['UnifiedId'] = UnifiedId +from apideck.model.create_employee_response import CreateEmployeeResponse + + +class TestCreateEmployeeResponse(unittest.TestCase): + """CreateEmployeeResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testCreateEmployeeResponse(self): + """Test CreateEmployeeResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = CreateEmployeeResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_create_file_request.py b/src/test/test_create_file_request.py new file mode 100644 index 0000000000..cefe8c9905 --- /dev/null +++ b/src/test/test_create_file_request.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.create_file_request import CreateFileRequest + + +class TestCreateFileRequest(unittest.TestCase): + """CreateFileRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testCreateFileRequest(self): + """Test CreateFileRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = CreateFileRequest() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_create_file_response.py b/src/test/test_create_file_response.py new file mode 100644 index 0000000000..64651b432a --- /dev/null +++ b/src/test/test_create_file_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId +globals()['UnifiedId'] = UnifiedId +from apideck.model.create_file_response import CreateFileResponse + + +class TestCreateFileResponse(unittest.TestCase): + """CreateFileResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testCreateFileResponse(self): + """Test CreateFileResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = CreateFileResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_create_folder_request.py b/src/test/test_create_folder_request.py new file mode 100644 index 0000000000..85b30dbaa3 --- /dev/null +++ b/src/test/test_create_folder_request.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.create_folder_request import CreateFolderRequest + + +class TestCreateFolderRequest(unittest.TestCase): + """CreateFolderRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testCreateFolderRequest(self): + """Test CreateFolderRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = CreateFolderRequest() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_create_folder_response.py b/src/test/test_create_folder_response.py new file mode 100644 index 0000000000..c95d9d2604 --- /dev/null +++ b/src/test/test_create_folder_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId +globals()['UnifiedId'] = UnifiedId +from apideck.model.create_folder_response import CreateFolderResponse + + +class TestCreateFolderResponse(unittest.TestCase): + """CreateFolderResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testCreateFolderResponse(self): + """Test CreateFolderResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = CreateFolderResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_create_hris_company_response.py b/src/test/test_create_hris_company_response.py new file mode 100644 index 0000000000..372679a0bd --- /dev/null +++ b/src/test/test_create_hris_company_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId +globals()['UnifiedId'] = UnifiedId +from apideck.model.create_hris_company_response import CreateHrisCompanyResponse + + +class TestCreateHrisCompanyResponse(unittest.TestCase): + """CreateHrisCompanyResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testCreateHrisCompanyResponse(self): + """Test CreateHrisCompanyResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = CreateHrisCompanyResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_create_invoice_item_response.py b/src/test/test_create_invoice_item_response.py new file mode 100644 index 0000000000..ca3a786c15 --- /dev/null +++ b/src/test/test_create_invoice_item_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId +globals()['UnifiedId'] = UnifiedId +from apideck.model.create_invoice_item_response import CreateInvoiceItemResponse + + +class TestCreateInvoiceItemResponse(unittest.TestCase): + """CreateInvoiceItemResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testCreateInvoiceItemResponse(self): + """Test CreateInvoiceItemResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = CreateInvoiceItemResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_create_invoice_response.py b/src/test/test_create_invoice_response.py new file mode 100644 index 0000000000..0f6eeae4ea --- /dev/null +++ b/src/test/test_create_invoice_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.invoice_response import InvoiceResponse +globals()['InvoiceResponse'] = InvoiceResponse +from apideck.model.create_invoice_response import CreateInvoiceResponse + + +class TestCreateInvoiceResponse(unittest.TestCase): + """CreateInvoiceResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testCreateInvoiceResponse(self): + """Test CreateInvoiceResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = CreateInvoiceResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_create_item_response.py b/src/test/test_create_item_response.py new file mode 100644 index 0000000000..9811511782 --- /dev/null +++ b/src/test/test_create_item_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId +globals()['UnifiedId'] = UnifiedId +from apideck.model.create_item_response import CreateItemResponse + + +class TestCreateItemResponse(unittest.TestCase): + """CreateItemResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testCreateItemResponse(self): + """Test CreateItemResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = CreateItemResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_create_job_response.py b/src/test/test_create_job_response.py new file mode 100644 index 0000000000..452ad38c40 --- /dev/null +++ b/src/test/test_create_job_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId +globals()['UnifiedId'] = UnifiedId +from apideck.model.create_job_response import CreateJobResponse + + +class TestCreateJobResponse(unittest.TestCase): + """CreateJobResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testCreateJobResponse(self): + """Test CreateJobResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = CreateJobResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_create_lead_response.py b/src/test/test_create_lead_response.py new file mode 100644 index 0000000000..2b31c649a5 --- /dev/null +++ b/src/test/test_create_lead_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId +globals()['UnifiedId'] = UnifiedId +from apideck.model.create_lead_response import CreateLeadResponse + + +class TestCreateLeadResponse(unittest.TestCase): + """CreateLeadResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testCreateLeadResponse(self): + """Test CreateLeadResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = CreateLeadResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_create_ledger_account_response.py b/src/test/test_create_ledger_account_response.py new file mode 100644 index 0000000000..602df467af --- /dev/null +++ b/src/test/test_create_ledger_account_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId +globals()['UnifiedId'] = UnifiedId +from apideck.model.create_ledger_account_response import CreateLedgerAccountResponse + + +class TestCreateLedgerAccountResponse(unittest.TestCase): + """CreateLedgerAccountResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testCreateLedgerAccountResponse(self): + """Test CreateLedgerAccountResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = CreateLedgerAccountResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_create_location_response.py b/src/test/test_create_location_response.py new file mode 100644 index 0000000000..813c210f57 --- /dev/null +++ b/src/test/test_create_location_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId +globals()['UnifiedId'] = UnifiedId +from apideck.model.create_location_response import CreateLocationResponse + + +class TestCreateLocationResponse(unittest.TestCase): + """CreateLocationResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testCreateLocationResponse(self): + """Test CreateLocationResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = CreateLocationResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_create_merchant_response.py b/src/test/test_create_merchant_response.py new file mode 100644 index 0000000000..4a991e5cd9 --- /dev/null +++ b/src/test/test_create_merchant_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId +globals()['UnifiedId'] = UnifiedId +from apideck.model.create_merchant_response import CreateMerchantResponse + + +class TestCreateMerchantResponse(unittest.TestCase): + """CreateMerchantResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testCreateMerchantResponse(self): + """Test CreateMerchantResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = CreateMerchantResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_create_message_response.py b/src/test/test_create_message_response.py new file mode 100644 index 0000000000..e34ba44108 --- /dev/null +++ b/src/test/test_create_message_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId +globals()['UnifiedId'] = UnifiedId +from apideck.model.create_message_response import CreateMessageResponse + + +class TestCreateMessageResponse(unittest.TestCase): + """CreateMessageResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testCreateMessageResponse(self): + """Test CreateMessageResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = CreateMessageResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_create_modifier_group_response.py b/src/test/test_create_modifier_group_response.py new file mode 100644 index 0000000000..629e07b5b3 --- /dev/null +++ b/src/test/test_create_modifier_group_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId +globals()['UnifiedId'] = UnifiedId +from apideck.model.create_modifier_group_response import CreateModifierGroupResponse + + +class TestCreateModifierGroupResponse(unittest.TestCase): + """CreateModifierGroupResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testCreateModifierGroupResponse(self): + """Test CreateModifierGroupResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = CreateModifierGroupResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_create_modifier_response.py b/src/test/test_create_modifier_response.py new file mode 100644 index 0000000000..ad03bd4ca2 --- /dev/null +++ b/src/test/test_create_modifier_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId +globals()['UnifiedId'] = UnifiedId +from apideck.model.create_modifier_response import CreateModifierResponse + + +class TestCreateModifierResponse(unittest.TestCase): + """CreateModifierResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testCreateModifierResponse(self): + """Test CreateModifierResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = CreateModifierResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_create_note_response.py b/src/test/test_create_note_response.py new file mode 100644 index 0000000000..3056611c38 --- /dev/null +++ b/src/test/test_create_note_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId +globals()['UnifiedId'] = UnifiedId +from apideck.model.create_note_response import CreateNoteResponse + + +class TestCreateNoteResponse(unittest.TestCase): + """CreateNoteResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testCreateNoteResponse(self): + """Test CreateNoteResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = CreateNoteResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_create_opportunity_response.py b/src/test/test_create_opportunity_response.py new file mode 100644 index 0000000000..01e0bc1e37 --- /dev/null +++ b/src/test/test_create_opportunity_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId +globals()['UnifiedId'] = UnifiedId +from apideck.model.create_opportunity_response import CreateOpportunityResponse + + +class TestCreateOpportunityResponse(unittest.TestCase): + """CreateOpportunityResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testCreateOpportunityResponse(self): + """Test CreateOpportunityResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = CreateOpportunityResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_create_order_response.py b/src/test/test_create_order_response.py new file mode 100644 index 0000000000..f0d16a753e --- /dev/null +++ b/src/test/test_create_order_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId +globals()['UnifiedId'] = UnifiedId +from apideck.model.create_order_response import CreateOrderResponse + + +class TestCreateOrderResponse(unittest.TestCase): + """CreateOrderResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testCreateOrderResponse(self): + """Test CreateOrderResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = CreateOrderResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_create_order_type_response.py b/src/test/test_create_order_type_response.py new file mode 100644 index 0000000000..5880e8969c --- /dev/null +++ b/src/test/test_create_order_type_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId +globals()['UnifiedId'] = UnifiedId +from apideck.model.create_order_type_response import CreateOrderTypeResponse + + +class TestCreateOrderTypeResponse(unittest.TestCase): + """CreateOrderTypeResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testCreateOrderTypeResponse(self): + """Test CreateOrderTypeResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = CreateOrderTypeResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_create_payment_response.py b/src/test/test_create_payment_response.py new file mode 100644 index 0000000000..67767eddb4 --- /dev/null +++ b/src/test/test_create_payment_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId +globals()['UnifiedId'] = UnifiedId +from apideck.model.create_payment_response import CreatePaymentResponse + + +class TestCreatePaymentResponse(unittest.TestCase): + """CreatePaymentResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testCreatePaymentResponse(self): + """Test CreatePaymentResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = CreatePaymentResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_create_pipeline_response.py b/src/test/test_create_pipeline_response.py new file mode 100644 index 0000000000..3b68fafaa3 --- /dev/null +++ b/src/test/test_create_pipeline_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId +globals()['UnifiedId'] = UnifiedId +from apideck.model.create_pipeline_response import CreatePipelineResponse + + +class TestCreatePipelineResponse(unittest.TestCase): + """CreatePipelineResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testCreatePipelineResponse(self): + """Test CreatePipelineResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = CreatePipelineResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_create_pos_payment_response.py b/src/test/test_create_pos_payment_response.py new file mode 100644 index 0000000000..528dfd6616 --- /dev/null +++ b/src/test/test_create_pos_payment_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId +globals()['UnifiedId'] = UnifiedId +from apideck.model.create_pos_payment_response import CreatePosPaymentResponse + + +class TestCreatePosPaymentResponse(unittest.TestCase): + """CreatePosPaymentResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testCreatePosPaymentResponse(self): + """Test CreatePosPaymentResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = CreatePosPaymentResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_create_session_response.py b/src/test/test_create_session_response.py new file mode 100644 index 0000000000..c44df01bc7 --- /dev/null +++ b/src/test/test_create_session_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.create_session_response_data import CreateSessionResponseData +globals()['CreateSessionResponseData'] = CreateSessionResponseData +from apideck.model.create_session_response import CreateSessionResponse + + +class TestCreateSessionResponse(unittest.TestCase): + """CreateSessionResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testCreateSessionResponse(self): + """Test CreateSessionResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = CreateSessionResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_create_session_response_data.py b/src/test/test_create_session_response_data.py new file mode 100644 index 0000000000..4971ec4641 --- /dev/null +++ b/src/test/test_create_session_response_data.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.create_session_response_data import CreateSessionResponseData + + +class TestCreateSessionResponseData(unittest.TestCase): + """CreateSessionResponseData unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testCreateSessionResponseData(self): + """Test CreateSessionResponseData""" + # FIXME: construct object with mandatory attributes with example values + # model = CreateSessionResponseData() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_create_shared_link_response.py b/src/test/test_create_shared_link_response.py new file mode 100644 index 0000000000..d43b99fe42 --- /dev/null +++ b/src/test/test_create_shared_link_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId +globals()['UnifiedId'] = UnifiedId +from apideck.model.create_shared_link_response import CreateSharedLinkResponse + + +class TestCreateSharedLinkResponse(unittest.TestCase): + """CreateSharedLinkResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testCreateSharedLinkResponse(self): + """Test CreateSharedLinkResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = CreateSharedLinkResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_create_supplier_response.py b/src/test/test_create_supplier_response.py new file mode 100644 index 0000000000..882ba794a2 --- /dev/null +++ b/src/test/test_create_supplier_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId +globals()['UnifiedId'] = UnifiedId +from apideck.model.create_supplier_response import CreateSupplierResponse + + +class TestCreateSupplierResponse(unittest.TestCase): + """CreateSupplierResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testCreateSupplierResponse(self): + """Test CreateSupplierResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = CreateSupplierResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_create_tax_rate_response.py b/src/test/test_create_tax_rate_response.py new file mode 100644 index 0000000000..c5d092ec10 --- /dev/null +++ b/src/test/test_create_tax_rate_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId +globals()['UnifiedId'] = UnifiedId +from apideck.model.create_tax_rate_response import CreateTaxRateResponse + + +class TestCreateTaxRateResponse(unittest.TestCase): + """CreateTaxRateResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testCreateTaxRateResponse(self): + """Test CreateTaxRateResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = CreateTaxRateResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_create_tender_response.py b/src/test/test_create_tender_response.py new file mode 100644 index 0000000000..8440c219a9 --- /dev/null +++ b/src/test/test_create_tender_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId +globals()['UnifiedId'] = UnifiedId +from apideck.model.create_tender_response import CreateTenderResponse + + +class TestCreateTenderResponse(unittest.TestCase): + """CreateTenderResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testCreateTenderResponse(self): + """Test CreateTenderResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = CreateTenderResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_create_time_off_request_response.py b/src/test/test_create_time_off_request_response.py new file mode 100644 index 0000000000..8766ebe799 --- /dev/null +++ b/src/test/test_create_time_off_request_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId +globals()['UnifiedId'] = UnifiedId +from apideck.model.create_time_off_request_response import CreateTimeOffRequestResponse + + +class TestCreateTimeOffRequestResponse(unittest.TestCase): + """CreateTimeOffRequestResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testCreateTimeOffRequestResponse(self): + """Test CreateTimeOffRequestResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = CreateTimeOffRequestResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_create_upload_session_request.py b/src/test/test_create_upload_session_request.py new file mode 100644 index 0000000000..9f889475c4 --- /dev/null +++ b/src/test/test_create_upload_session_request.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.create_upload_session_request import CreateUploadSessionRequest + + +class TestCreateUploadSessionRequest(unittest.TestCase): + """CreateUploadSessionRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testCreateUploadSessionRequest(self): + """Test CreateUploadSessionRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = CreateUploadSessionRequest() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_create_upload_session_response.py b/src/test/test_create_upload_session_response.py new file mode 100644 index 0000000000..416c08cc5d --- /dev/null +++ b/src/test/test_create_upload_session_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId +globals()['UnifiedId'] = UnifiedId +from apideck.model.create_upload_session_response import CreateUploadSessionResponse + + +class TestCreateUploadSessionResponse(unittest.TestCase): + """CreateUploadSessionResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testCreateUploadSessionResponse(self): + """Test CreateUploadSessionResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = CreateUploadSessionResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_create_user_response.py b/src/test/test_create_user_response.py new file mode 100644 index 0000000000..785f58e1b8 --- /dev/null +++ b/src/test/test_create_user_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId +globals()['UnifiedId'] = UnifiedId +from apideck.model.create_user_response import CreateUserResponse + + +class TestCreateUserResponse(unittest.TestCase): + """CreateUserResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testCreateUserResponse(self): + """Test CreateUserResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = CreateUserResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_create_webhook_request.py b/src/test/test_create_webhook_request.py new file mode 100644 index 0000000000..3a8032eb31 --- /dev/null +++ b/src/test/test_create_webhook_request.py @@ -0,0 +1,43 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.delivery_url import DeliveryUrl +from apideck.model.status import Status +from apideck.model.unified_api_id import UnifiedApiId +from apideck.model.webhook_event_type import WebhookEventType +globals()['DeliveryUrl'] = DeliveryUrl +globals()['Status'] = Status +globals()['UnifiedApiId'] = UnifiedApiId +globals()['WebhookEventType'] = WebhookEventType +from apideck.model.create_webhook_request import CreateWebhookRequest + + +class TestCreateWebhookRequest(unittest.TestCase): + """CreateWebhookRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testCreateWebhookRequest(self): + """Test CreateWebhookRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = CreateWebhookRequest() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_create_webhook_response.py b/src/test/test_create_webhook_response.py new file mode 100644 index 0000000000..1dcbc739ef --- /dev/null +++ b/src/test/test_create_webhook_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.webhook import Webhook +globals()['Webhook'] = Webhook +from apideck.model.create_webhook_response import CreateWebhookResponse + + +class TestCreateWebhookResponse(unittest.TestCase): + """CreateWebhookResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testCreateWebhookResponse(self): + """Test CreateWebhookResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = CreateWebhookResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_credit_note.py b/src/test/test_credit_note.py new file mode 100644 index 0000000000..9a6654812f --- /dev/null +++ b/src/test/test_credit_note.py @@ -0,0 +1,43 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.currency import Currency +from apideck.model.invoice_line_item import InvoiceLineItem +from apideck.model.linked_customer import LinkedCustomer +from apideck.model.linked_ledger_account import LinkedLedgerAccount +globals()['Currency'] = Currency +globals()['InvoiceLineItem'] = InvoiceLineItem +globals()['LinkedCustomer'] = LinkedCustomer +globals()['LinkedLedgerAccount'] = LinkedLedgerAccount +from apideck.model.credit_note import CreditNote + + +class TestCreditNote(unittest.TestCase): + """CreditNote unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testCreditNote(self): + """Test CreditNote""" + # FIXME: construct object with mandatory attributes with example values + # model = CreditNote() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_crm_api.py b/src/test/test_crm_api.py new file mode 100644 index 0000000000..da3d0c7455 --- /dev/null +++ b/src/test/test_crm_api.py @@ -0,0 +1,308 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import apideck +from apideck.api.crm_api import CrmApi # noqa: E501 + + +class TestCrmApi(unittest.TestCase): + """CrmApi unit test stubs""" + + def setUp(self): + self.api = CrmApi() # noqa: E501 + + def tearDown(self): + pass + + def test_activities_add(self): + """Test case for activities_add + + Create activity # noqa: E501 + """ + pass + + def test_activities_all(self): + """Test case for activities_all + + List activities # noqa: E501 + """ + pass + + def test_activities_delete(self): + """Test case for activities_delete + + Delete activity # noqa: E501 + """ + pass + + def test_activities_one(self): + """Test case for activities_one + + Get activity # noqa: E501 + """ + pass + + def test_activities_update(self): + """Test case for activities_update + + Update activity # noqa: E501 + """ + pass + + def test_companies_add(self): + """Test case for companies_add + + Create company # noqa: E501 + """ + pass + + def test_companies_all(self): + """Test case for companies_all + + List companies # noqa: E501 + """ + pass + + def test_companies_delete(self): + """Test case for companies_delete + + Delete company # noqa: E501 + """ + pass + + def test_companies_one(self): + """Test case for companies_one + + Get company # noqa: E501 + """ + pass + + def test_companies_update(self): + """Test case for companies_update + + Update company # noqa: E501 + """ + pass + + def test_contacts_add(self): + """Test case for contacts_add + + Create contact # noqa: E501 + """ + pass + + def test_contacts_all(self): + """Test case for contacts_all + + List contacts # noqa: E501 + """ + pass + + def test_contacts_delete(self): + """Test case for contacts_delete + + Delete contact # noqa: E501 + """ + pass + + def test_contacts_one(self): + """Test case for contacts_one + + Get contact # noqa: E501 + """ + pass + + def test_contacts_update(self): + """Test case for contacts_update + + Update contact # noqa: E501 + """ + pass + + def test_leads_add(self): + """Test case for leads_add + + Create lead # noqa: E501 + """ + pass + + def test_leads_all(self): + """Test case for leads_all + + List leads # noqa: E501 + """ + pass + + def test_leads_delete(self): + """Test case for leads_delete + + Delete lead # noqa: E501 + """ + pass + + def test_leads_one(self): + """Test case for leads_one + + Get lead # noqa: E501 + """ + pass + + def test_leads_update(self): + """Test case for leads_update + + Update lead # noqa: E501 + """ + pass + + def test_notes_add(self): + """Test case for notes_add + + Create note # noqa: E501 + """ + pass + + def test_notes_all(self): + """Test case for notes_all + + List notes # noqa: E501 + """ + pass + + def test_notes_delete(self): + """Test case for notes_delete + + Delete note # noqa: E501 + """ + pass + + def test_notes_one(self): + """Test case for notes_one + + Get note # noqa: E501 + """ + pass + + def test_notes_update(self): + """Test case for notes_update + + Update note # noqa: E501 + """ + pass + + def test_opportunities_add(self): + """Test case for opportunities_add + + Create opportunity # noqa: E501 + """ + pass + + def test_opportunities_all(self): + """Test case for opportunities_all + + List opportunities # noqa: E501 + """ + pass + + def test_opportunities_delete(self): + """Test case for opportunities_delete + + Delete opportunity # noqa: E501 + """ + pass + + def test_opportunities_one(self): + """Test case for opportunities_one + + Get opportunity # noqa: E501 + """ + pass + + def test_opportunities_update(self): + """Test case for opportunities_update + + Update opportunity # noqa: E501 + """ + pass + + def test_pipelines_add(self): + """Test case for pipelines_add + + Create pipeline # noqa: E501 + """ + pass + + def test_pipelines_all(self): + """Test case for pipelines_all + + List pipelines # noqa: E501 + """ + pass + + def test_pipelines_delete(self): + """Test case for pipelines_delete + + Delete pipeline # noqa: E501 + """ + pass + + def test_pipelines_one(self): + """Test case for pipelines_one + + Get pipeline # noqa: E501 + """ + pass + + def test_pipelines_update(self): + """Test case for pipelines_update + + Update pipeline # noqa: E501 + """ + pass + + def test_users_add(self): + """Test case for users_add + + Create user # noqa: E501 + """ + pass + + def test_users_all(self): + """Test case for users_all + + List users # noqa: E501 + """ + pass + + def test_users_delete(self): + """Test case for users_delete + + Delete user # noqa: E501 + """ + pass + + def test_users_one(self): + """Test case for users_one + + Get user # noqa: E501 + """ + pass + + def test_users_update(self): + """Test case for users_update + + Update user # noqa: E501 + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_crm_event_type.py b/src/test/test_crm_event_type.py new file mode 100644 index 0000000000..3c194ed3ae --- /dev/null +++ b/src/test/test_crm_event_type.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.crm_event_type import CrmEventType + + +class TestCrmEventType(unittest.TestCase): + """CrmEventType unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testCrmEventType(self): + """Test CrmEventType""" + # FIXME: construct object with mandatory attributes with example values + # model = CrmEventType() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_currency.py b/src/test/test_currency.py new file mode 100644 index 0000000000..87d7b19441 --- /dev/null +++ b/src/test/test_currency.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.currency import Currency + + +class TestCurrency(unittest.TestCase): + """Currency unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testCurrency(self): + """Test Currency""" + # FIXME: construct object with mandatory attributes with example values + # model = Currency() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_custom_field.py b/src/test/test_custom_field.py new file mode 100644 index 0000000000..3312316eb5 --- /dev/null +++ b/src/test/test_custom_field.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.custom_field import CustomField + + +class TestCustomField(unittest.TestCase): + """CustomField unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testCustomField(self): + """Test CustomField""" + # FIXME: construct object with mandatory attributes with example values + # model = CustomField() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_customer_support_api.py b/src/test/test_customer_support_api.py new file mode 100644 index 0000000000..dd380222b1 --- /dev/null +++ b/src/test/test_customer_support_api.py @@ -0,0 +1,63 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import apideck +from apideck.api.customer_support_api import CustomerSupportApi # noqa: E501 + + +class TestCustomerSupportApi(unittest.TestCase): + """CustomerSupportApi unit test stubs""" + + def setUp(self): + self.api = CustomerSupportApi() # noqa: E501 + + def tearDown(self): + pass + + def test_customers_add(self): + """Test case for customers_add + + Create Customer Support Customer # noqa: E501 + """ + pass + + def test_customers_all(self): + """Test case for customers_all + + List Customer Support Customers # noqa: E501 + """ + pass + + def test_customers_delete(self): + """Test case for customers_delete + + Delete Customer Support Customer # noqa: E501 + """ + pass + + def test_customers_one(self): + """Test case for customers_one + + Get Customer Support Customer # noqa: E501 + """ + pass + + def test_customers_update(self): + """Test case for customers_update + + Update Customer Support Customer # noqa: E501 + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_customer_support_customer.py b/src/test/test_customer_support_customer.py new file mode 100644 index 0000000000..db8af1fdf1 --- /dev/null +++ b/src/test/test_customer_support_customer.py @@ -0,0 +1,45 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.address import Address +from apideck.model.bank_account import BankAccount +from apideck.model.currency import Currency +from apideck.model.email import Email +from apideck.model.phone_number import PhoneNumber +globals()['Address'] = Address +globals()['BankAccount'] = BankAccount +globals()['Currency'] = Currency +globals()['Email'] = Email +globals()['PhoneNumber'] = PhoneNumber +from apideck.model.customer_support_customer import CustomerSupportCustomer + + +class TestCustomerSupportCustomer(unittest.TestCase): + """CustomerSupportCustomer unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testCustomerSupportCustomer(self): + """Test CustomerSupportCustomer""" + # FIXME: construct object with mandatory attributes with example values + # model = CustomerSupportCustomer() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_customers_filter.py b/src/test/test_customers_filter.py new file mode 100644 index 0000000000..c56c6f4a11 --- /dev/null +++ b/src/test/test_customers_filter.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.customers_filter import CustomersFilter + + +class TestCustomersFilter(unittest.TestCase): + """CustomersFilter unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testCustomersFilter(self): + """Test CustomersFilter""" + # FIXME: construct object with mandatory attributes with example values + # model = CustomersFilter() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_deduction.py b/src/test/test_deduction.py new file mode 100644 index 0000000000..6ed76d5366 --- /dev/null +++ b/src/test/test_deduction.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.deduction import Deduction + + +class TestDeduction(unittest.TestCase): + """Deduction unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testDeduction(self): + """Test Deduction""" + # FIXME: construct object with mandatory attributes with example values + # model = Deduction() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_delete_activity_response.py b/src/test/test_delete_activity_response.py new file mode 100644 index 0000000000..73ce8fa114 --- /dev/null +++ b/src/test/test_delete_activity_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId +globals()['UnifiedId'] = UnifiedId +from apideck.model.delete_activity_response import DeleteActivityResponse + + +class TestDeleteActivityResponse(unittest.TestCase): + """DeleteActivityResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testDeleteActivityResponse(self): + """Test DeleteActivityResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = DeleteActivityResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_delete_bill_response.py b/src/test/test_delete_bill_response.py new file mode 100644 index 0000000000..9ad396b897 --- /dev/null +++ b/src/test/test_delete_bill_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId +globals()['UnifiedId'] = UnifiedId +from apideck.model.delete_bill_response import DeleteBillResponse + + +class TestDeleteBillResponse(unittest.TestCase): + """DeleteBillResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testDeleteBillResponse(self): + """Test DeleteBillResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = DeleteBillResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_delete_company_response.py b/src/test/test_delete_company_response.py new file mode 100644 index 0000000000..f3cdd9f5d2 --- /dev/null +++ b/src/test/test_delete_company_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId +globals()['UnifiedId'] = UnifiedId +from apideck.model.delete_company_response import DeleteCompanyResponse + + +class TestDeleteCompanyResponse(unittest.TestCase): + """DeleteCompanyResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testDeleteCompanyResponse(self): + """Test DeleteCompanyResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = DeleteCompanyResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_delete_contact_response.py b/src/test/test_delete_contact_response.py new file mode 100644 index 0000000000..4d7e54afa0 --- /dev/null +++ b/src/test/test_delete_contact_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId +globals()['UnifiedId'] = UnifiedId +from apideck.model.delete_contact_response import DeleteContactResponse + + +class TestDeleteContactResponse(unittest.TestCase): + """DeleteContactResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testDeleteContactResponse(self): + """Test DeleteContactResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = DeleteContactResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_delete_credit_note_response.py b/src/test/test_delete_credit_note_response.py new file mode 100644 index 0000000000..e61b047ea9 --- /dev/null +++ b/src/test/test_delete_credit_note_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId +globals()['UnifiedId'] = UnifiedId +from apideck.model.delete_credit_note_response import DeleteCreditNoteResponse + + +class TestDeleteCreditNoteResponse(unittest.TestCase): + """DeleteCreditNoteResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testDeleteCreditNoteResponse(self): + """Test DeleteCreditNoteResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = DeleteCreditNoteResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_delete_customer_response.py b/src/test/test_delete_customer_response.py new file mode 100644 index 0000000000..ab2bab7369 --- /dev/null +++ b/src/test/test_delete_customer_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId +globals()['UnifiedId'] = UnifiedId +from apideck.model.delete_customer_response import DeleteCustomerResponse + + +class TestDeleteCustomerResponse(unittest.TestCase): + """DeleteCustomerResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testDeleteCustomerResponse(self): + """Test DeleteCustomerResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = DeleteCustomerResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_delete_customer_support_customer_response.py b/src/test/test_delete_customer_support_customer_response.py new file mode 100644 index 0000000000..5990ff742d --- /dev/null +++ b/src/test/test_delete_customer_support_customer_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId +globals()['UnifiedId'] = UnifiedId +from apideck.model.delete_customer_support_customer_response import DeleteCustomerSupportCustomerResponse + + +class TestDeleteCustomerSupportCustomerResponse(unittest.TestCase): + """DeleteCustomerSupportCustomerResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testDeleteCustomerSupportCustomerResponse(self): + """Test DeleteCustomerSupportCustomerResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = DeleteCustomerSupportCustomerResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_delete_department_response.py b/src/test/test_delete_department_response.py new file mode 100644 index 0000000000..e7e281e787 --- /dev/null +++ b/src/test/test_delete_department_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId +globals()['UnifiedId'] = UnifiedId +from apideck.model.delete_department_response import DeleteDepartmentResponse + + +class TestDeleteDepartmentResponse(unittest.TestCase): + """DeleteDepartmentResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testDeleteDepartmentResponse(self): + """Test DeleteDepartmentResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = DeleteDepartmentResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_delete_drive_group_response.py b/src/test/test_delete_drive_group_response.py new file mode 100644 index 0000000000..717f0fd118 --- /dev/null +++ b/src/test/test_delete_drive_group_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId +globals()['UnifiedId'] = UnifiedId +from apideck.model.delete_drive_group_response import DeleteDriveGroupResponse + + +class TestDeleteDriveGroupResponse(unittest.TestCase): + """DeleteDriveGroupResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testDeleteDriveGroupResponse(self): + """Test DeleteDriveGroupResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = DeleteDriveGroupResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_delete_drive_response.py b/src/test/test_delete_drive_response.py new file mode 100644 index 0000000000..6507d0e67b --- /dev/null +++ b/src/test/test_delete_drive_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId +globals()['UnifiedId'] = UnifiedId +from apideck.model.delete_drive_response import DeleteDriveResponse + + +class TestDeleteDriveResponse(unittest.TestCase): + """DeleteDriveResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testDeleteDriveResponse(self): + """Test DeleteDriveResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = DeleteDriveResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_delete_employee_response.py b/src/test/test_delete_employee_response.py new file mode 100644 index 0000000000..f204eab247 --- /dev/null +++ b/src/test/test_delete_employee_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId +globals()['UnifiedId'] = UnifiedId +from apideck.model.delete_employee_response import DeleteEmployeeResponse + + +class TestDeleteEmployeeResponse(unittest.TestCase): + """DeleteEmployeeResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testDeleteEmployeeResponse(self): + """Test DeleteEmployeeResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = DeleteEmployeeResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_delete_file_response.py b/src/test/test_delete_file_response.py new file mode 100644 index 0000000000..ccaf584868 --- /dev/null +++ b/src/test/test_delete_file_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId +globals()['UnifiedId'] = UnifiedId +from apideck.model.delete_file_response import DeleteFileResponse + + +class TestDeleteFileResponse(unittest.TestCase): + """DeleteFileResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testDeleteFileResponse(self): + """Test DeleteFileResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = DeleteFileResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_delete_folder_response.py b/src/test/test_delete_folder_response.py new file mode 100644 index 0000000000..370b4c9209 --- /dev/null +++ b/src/test/test_delete_folder_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId +globals()['UnifiedId'] = UnifiedId +from apideck.model.delete_folder_response import DeleteFolderResponse + + +class TestDeleteFolderResponse(unittest.TestCase): + """DeleteFolderResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testDeleteFolderResponse(self): + """Test DeleteFolderResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = DeleteFolderResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_delete_hris_company_response.py b/src/test/test_delete_hris_company_response.py new file mode 100644 index 0000000000..0b374562c7 --- /dev/null +++ b/src/test/test_delete_hris_company_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId +globals()['UnifiedId'] = UnifiedId +from apideck.model.delete_hris_company_response import DeleteHrisCompanyResponse + + +class TestDeleteHrisCompanyResponse(unittest.TestCase): + """DeleteHrisCompanyResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testDeleteHrisCompanyResponse(self): + """Test DeleteHrisCompanyResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = DeleteHrisCompanyResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_delete_invoice_item_response.py b/src/test/test_delete_invoice_item_response.py new file mode 100644 index 0000000000..a2a56853b8 --- /dev/null +++ b/src/test/test_delete_invoice_item_response.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.delete_invoice_item_response import DeleteInvoiceItemResponse + + +class TestDeleteInvoiceItemResponse(unittest.TestCase): + """DeleteInvoiceItemResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testDeleteInvoiceItemResponse(self): + """Test DeleteInvoiceItemResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = DeleteInvoiceItemResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_delete_invoice_response.py b/src/test/test_delete_invoice_response.py new file mode 100644 index 0000000000..216a895c43 --- /dev/null +++ b/src/test/test_delete_invoice_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.invoice_response import InvoiceResponse +globals()['InvoiceResponse'] = InvoiceResponse +from apideck.model.delete_invoice_response import DeleteInvoiceResponse + + +class TestDeleteInvoiceResponse(unittest.TestCase): + """DeleteInvoiceResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testDeleteInvoiceResponse(self): + """Test DeleteInvoiceResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = DeleteInvoiceResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_delete_item_response.py b/src/test/test_delete_item_response.py new file mode 100644 index 0000000000..08f18cb0ff --- /dev/null +++ b/src/test/test_delete_item_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId +globals()['UnifiedId'] = UnifiedId +from apideck.model.delete_item_response import DeleteItemResponse + + +class TestDeleteItemResponse(unittest.TestCase): + """DeleteItemResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testDeleteItemResponse(self): + """Test DeleteItemResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = DeleteItemResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_delete_job_response.py b/src/test/test_delete_job_response.py new file mode 100644 index 0000000000..b6ea79a801 --- /dev/null +++ b/src/test/test_delete_job_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId +globals()['UnifiedId'] = UnifiedId +from apideck.model.delete_job_response import DeleteJobResponse + + +class TestDeleteJobResponse(unittest.TestCase): + """DeleteJobResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testDeleteJobResponse(self): + """Test DeleteJobResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = DeleteJobResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_delete_lead_response.py b/src/test/test_delete_lead_response.py new file mode 100644 index 0000000000..04e39351cf --- /dev/null +++ b/src/test/test_delete_lead_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId +globals()['UnifiedId'] = UnifiedId +from apideck.model.delete_lead_response import DeleteLeadResponse + + +class TestDeleteLeadResponse(unittest.TestCase): + """DeleteLeadResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testDeleteLeadResponse(self): + """Test DeleteLeadResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = DeleteLeadResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_delete_ledger_account_response.py b/src/test/test_delete_ledger_account_response.py new file mode 100644 index 0000000000..785ea7fcbd --- /dev/null +++ b/src/test/test_delete_ledger_account_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId +globals()['UnifiedId'] = UnifiedId +from apideck.model.delete_ledger_account_response import DeleteLedgerAccountResponse + + +class TestDeleteLedgerAccountResponse(unittest.TestCase): + """DeleteLedgerAccountResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testDeleteLedgerAccountResponse(self): + """Test DeleteLedgerAccountResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = DeleteLedgerAccountResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_delete_location_response.py b/src/test/test_delete_location_response.py new file mode 100644 index 0000000000..9f513fad82 --- /dev/null +++ b/src/test/test_delete_location_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId +globals()['UnifiedId'] = UnifiedId +from apideck.model.delete_location_response import DeleteLocationResponse + + +class TestDeleteLocationResponse(unittest.TestCase): + """DeleteLocationResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testDeleteLocationResponse(self): + """Test DeleteLocationResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = DeleteLocationResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_delete_merchant_response.py b/src/test/test_delete_merchant_response.py new file mode 100644 index 0000000000..ea72c11007 --- /dev/null +++ b/src/test/test_delete_merchant_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId +globals()['UnifiedId'] = UnifiedId +from apideck.model.delete_merchant_response import DeleteMerchantResponse + + +class TestDeleteMerchantResponse(unittest.TestCase): + """DeleteMerchantResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testDeleteMerchantResponse(self): + """Test DeleteMerchantResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = DeleteMerchantResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_delete_message_response.py b/src/test/test_delete_message_response.py new file mode 100644 index 0000000000..71a7f8665e --- /dev/null +++ b/src/test/test_delete_message_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId +globals()['UnifiedId'] = UnifiedId +from apideck.model.delete_message_response import DeleteMessageResponse + + +class TestDeleteMessageResponse(unittest.TestCase): + """DeleteMessageResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testDeleteMessageResponse(self): + """Test DeleteMessageResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = DeleteMessageResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_delete_modifier_group_response.py b/src/test/test_delete_modifier_group_response.py new file mode 100644 index 0000000000..e78052e114 --- /dev/null +++ b/src/test/test_delete_modifier_group_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId +globals()['UnifiedId'] = UnifiedId +from apideck.model.delete_modifier_group_response import DeleteModifierGroupResponse + + +class TestDeleteModifierGroupResponse(unittest.TestCase): + """DeleteModifierGroupResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testDeleteModifierGroupResponse(self): + """Test DeleteModifierGroupResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = DeleteModifierGroupResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_delete_modifier_response.py b/src/test/test_delete_modifier_response.py new file mode 100644 index 0000000000..675bf33798 --- /dev/null +++ b/src/test/test_delete_modifier_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId +globals()['UnifiedId'] = UnifiedId +from apideck.model.delete_modifier_response import DeleteModifierResponse + + +class TestDeleteModifierResponse(unittest.TestCase): + """DeleteModifierResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testDeleteModifierResponse(self): + """Test DeleteModifierResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = DeleteModifierResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_delete_note_response.py b/src/test/test_delete_note_response.py new file mode 100644 index 0000000000..28362c78bb --- /dev/null +++ b/src/test/test_delete_note_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId +globals()['UnifiedId'] = UnifiedId +from apideck.model.delete_note_response import DeleteNoteResponse + + +class TestDeleteNoteResponse(unittest.TestCase): + """DeleteNoteResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testDeleteNoteResponse(self): + """Test DeleteNoteResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = DeleteNoteResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_delete_opportunity_response.py b/src/test/test_delete_opportunity_response.py new file mode 100644 index 0000000000..1b660469ae --- /dev/null +++ b/src/test/test_delete_opportunity_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId +globals()['UnifiedId'] = UnifiedId +from apideck.model.delete_opportunity_response import DeleteOpportunityResponse + + +class TestDeleteOpportunityResponse(unittest.TestCase): + """DeleteOpportunityResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testDeleteOpportunityResponse(self): + """Test DeleteOpportunityResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = DeleteOpportunityResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_delete_order_response.py b/src/test/test_delete_order_response.py new file mode 100644 index 0000000000..771b39f91c --- /dev/null +++ b/src/test/test_delete_order_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId +globals()['UnifiedId'] = UnifiedId +from apideck.model.delete_order_response import DeleteOrderResponse + + +class TestDeleteOrderResponse(unittest.TestCase): + """DeleteOrderResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testDeleteOrderResponse(self): + """Test DeleteOrderResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = DeleteOrderResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_delete_order_type_response.py b/src/test/test_delete_order_type_response.py new file mode 100644 index 0000000000..c39c9f7082 --- /dev/null +++ b/src/test/test_delete_order_type_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId +globals()['UnifiedId'] = UnifiedId +from apideck.model.delete_order_type_response import DeleteOrderTypeResponse + + +class TestDeleteOrderTypeResponse(unittest.TestCase): + """DeleteOrderTypeResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testDeleteOrderTypeResponse(self): + """Test DeleteOrderTypeResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = DeleteOrderTypeResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_delete_payment_response.py b/src/test/test_delete_payment_response.py new file mode 100644 index 0000000000..169c964fd4 --- /dev/null +++ b/src/test/test_delete_payment_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId +globals()['UnifiedId'] = UnifiedId +from apideck.model.delete_payment_response import DeletePaymentResponse + + +class TestDeletePaymentResponse(unittest.TestCase): + """DeletePaymentResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testDeletePaymentResponse(self): + """Test DeletePaymentResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = DeletePaymentResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_delete_pipeline_response.py b/src/test/test_delete_pipeline_response.py new file mode 100644 index 0000000000..df7f2b4f8e --- /dev/null +++ b/src/test/test_delete_pipeline_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId +globals()['UnifiedId'] = UnifiedId +from apideck.model.delete_pipeline_response import DeletePipelineResponse + + +class TestDeletePipelineResponse(unittest.TestCase): + """DeletePipelineResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testDeletePipelineResponse(self): + """Test DeletePipelineResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = DeletePipelineResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_delete_pos_payment_response.py b/src/test/test_delete_pos_payment_response.py new file mode 100644 index 0000000000..f3a97bab53 --- /dev/null +++ b/src/test/test_delete_pos_payment_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId +globals()['UnifiedId'] = UnifiedId +from apideck.model.delete_pos_payment_response import DeletePosPaymentResponse + + +class TestDeletePosPaymentResponse(unittest.TestCase): + """DeletePosPaymentResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testDeletePosPaymentResponse(self): + """Test DeletePosPaymentResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = DeletePosPaymentResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_delete_shared_link_response.py b/src/test/test_delete_shared_link_response.py new file mode 100644 index 0000000000..aa842d076b --- /dev/null +++ b/src/test/test_delete_shared_link_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId +globals()['UnifiedId'] = UnifiedId +from apideck.model.delete_shared_link_response import DeleteSharedLinkResponse + + +class TestDeleteSharedLinkResponse(unittest.TestCase): + """DeleteSharedLinkResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testDeleteSharedLinkResponse(self): + """Test DeleteSharedLinkResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = DeleteSharedLinkResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_delete_supplier_response.py b/src/test/test_delete_supplier_response.py new file mode 100644 index 0000000000..e46f18486f --- /dev/null +++ b/src/test/test_delete_supplier_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId +globals()['UnifiedId'] = UnifiedId +from apideck.model.delete_supplier_response import DeleteSupplierResponse + + +class TestDeleteSupplierResponse(unittest.TestCase): + """DeleteSupplierResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testDeleteSupplierResponse(self): + """Test DeleteSupplierResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = DeleteSupplierResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_delete_tax_rate_response.py b/src/test/test_delete_tax_rate_response.py new file mode 100644 index 0000000000..43032fda43 --- /dev/null +++ b/src/test/test_delete_tax_rate_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId +globals()['UnifiedId'] = UnifiedId +from apideck.model.delete_tax_rate_response import DeleteTaxRateResponse + + +class TestDeleteTaxRateResponse(unittest.TestCase): + """DeleteTaxRateResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testDeleteTaxRateResponse(self): + """Test DeleteTaxRateResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = DeleteTaxRateResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_delete_tender_response.py b/src/test/test_delete_tender_response.py new file mode 100644 index 0000000000..2d08db630d --- /dev/null +++ b/src/test/test_delete_tender_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId +globals()['UnifiedId'] = UnifiedId +from apideck.model.delete_tender_response import DeleteTenderResponse + + +class TestDeleteTenderResponse(unittest.TestCase): + """DeleteTenderResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testDeleteTenderResponse(self): + """Test DeleteTenderResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = DeleteTenderResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_delete_time_off_request_response.py b/src/test/test_delete_time_off_request_response.py new file mode 100644 index 0000000000..b24355a416 --- /dev/null +++ b/src/test/test_delete_time_off_request_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId +globals()['UnifiedId'] = UnifiedId +from apideck.model.delete_time_off_request_response import DeleteTimeOffRequestResponse + + +class TestDeleteTimeOffRequestResponse(unittest.TestCase): + """DeleteTimeOffRequestResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testDeleteTimeOffRequestResponse(self): + """Test DeleteTimeOffRequestResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = DeleteTimeOffRequestResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_delete_upload_session_response.py b/src/test/test_delete_upload_session_response.py new file mode 100644 index 0000000000..7f17bb1933 --- /dev/null +++ b/src/test/test_delete_upload_session_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId +globals()['UnifiedId'] = UnifiedId +from apideck.model.delete_upload_session_response import DeleteUploadSessionResponse + + +class TestDeleteUploadSessionResponse(unittest.TestCase): + """DeleteUploadSessionResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testDeleteUploadSessionResponse(self): + """Test DeleteUploadSessionResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = DeleteUploadSessionResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_delete_user_response.py b/src/test/test_delete_user_response.py new file mode 100644 index 0000000000..bdc756ab69 --- /dev/null +++ b/src/test/test_delete_user_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId +globals()['UnifiedId'] = UnifiedId +from apideck.model.delete_user_response import DeleteUserResponse + + +class TestDeleteUserResponse(unittest.TestCase): + """DeleteUserResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testDeleteUserResponse(self): + """Test DeleteUserResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = DeleteUserResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_delete_webhook_response.py b/src/test/test_delete_webhook_response.py new file mode 100644 index 0000000000..bb7c96b80d --- /dev/null +++ b/src/test/test_delete_webhook_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.webhook import Webhook +globals()['Webhook'] = Webhook +from apideck.model.delete_webhook_response import DeleteWebhookResponse + + +class TestDeleteWebhookResponse(unittest.TestCase): + """DeleteWebhookResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testDeleteWebhookResponse(self): + """Test DeleteWebhookResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = DeleteWebhookResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_delivery_url.py b/src/test/test_delivery_url.py new file mode 100644 index 0000000000..29857a54e1 --- /dev/null +++ b/src/test/test_delivery_url.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.delivery_url import DeliveryUrl + + +class TestDeliveryUrl(unittest.TestCase): + """DeliveryUrl unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testDeliveryUrl(self): + """Test DeliveryUrl""" + # FIXME: construct object with mandatory attributes with example values + # model = DeliveryUrl() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_department.py b/src/test/test_department.py new file mode 100644 index 0000000000..f40006cdb1 --- /dev/null +++ b/src/test/test_department.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.department import Department + + +class TestDepartment(unittest.TestCase): + """Department unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testDepartment(self): + """Test Department""" + # FIXME: construct object with mandatory attributes with example values + # model = Department() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_drive.py b/src/test/test_drive.py new file mode 100644 index 0000000000..cdb15a0eaf --- /dev/null +++ b/src/test/test_drive.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.drive import Drive + + +class TestDrive(unittest.TestCase): + """Drive unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testDrive(self): + """Test Drive""" + # FIXME: construct object with mandatory attributes with example values + # model = Drive() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_drive_group.py b/src/test/test_drive_group.py new file mode 100644 index 0000000000..7073ebe7ef --- /dev/null +++ b/src/test/test_drive_group.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.drive_group import DriveGroup + + +class TestDriveGroup(unittest.TestCase): + """DriveGroup unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testDriveGroup(self): + """Test DriveGroup""" + # FIXME: construct object with mandatory attributes with example values + # model = DriveGroup() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_drive_groups_filter.py b/src/test/test_drive_groups_filter.py new file mode 100644 index 0000000000..cb51391514 --- /dev/null +++ b/src/test/test_drive_groups_filter.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.drive_groups_filter import DriveGroupsFilter + + +class TestDriveGroupsFilter(unittest.TestCase): + """DriveGroupsFilter unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testDriveGroupsFilter(self): + """Test DriveGroupsFilter""" + # FIXME: construct object with mandatory attributes with example values + # model = DriveGroupsFilter() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_drives_filter.py b/src/test/test_drives_filter.py new file mode 100644 index 0000000000..1ec14f75bc --- /dev/null +++ b/src/test/test_drives_filter.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.drives_filter import DrivesFilter + + +class TestDrivesFilter(unittest.TestCase): + """DrivesFilter unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testDrivesFilter(self): + """Test DrivesFilter""" + # FIXME: construct object with mandatory attributes with example values + # model = DrivesFilter() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_email.py b/src/test/test_email.py new file mode 100644 index 0000000000..6f2ad5e905 --- /dev/null +++ b/src/test/test_email.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.email import Email + + +class TestEmail(unittest.TestCase): + """Email unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testEmail(self): + """Test Email""" + # FIXME: construct object with mandatory attributes with example values + # model = Email() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_employee.py b/src/test/test_employee.py new file mode 100644 index 0000000000..e76cd5a7af --- /dev/null +++ b/src/test/test_employee.py @@ -0,0 +1,59 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.address import Address +from apideck.model.applicant_social_links import ApplicantSocialLinks +from apideck.model.custom_field import CustomField +from apideck.model.email import Email +from apideck.model.employee_compensations import EmployeeCompensations +from apideck.model.employee_employment_role import EmployeeEmploymentRole +from apideck.model.employee_jobs import EmployeeJobs +from apideck.model.employee_manager import EmployeeManager +from apideck.model.employee_partner import EmployeePartner +from apideck.model.employee_team import EmployeeTeam +from apideck.model.gender import Gender +from apideck.model.phone_number import PhoneNumber +globals()['Address'] = Address +globals()['ApplicantSocialLinks'] = ApplicantSocialLinks +globals()['CustomField'] = CustomField +globals()['Email'] = Email +globals()['EmployeeCompensations'] = EmployeeCompensations +globals()['EmployeeEmploymentRole'] = EmployeeEmploymentRole +globals()['EmployeeJobs'] = EmployeeJobs +globals()['EmployeeManager'] = EmployeeManager +globals()['EmployeePartner'] = EmployeePartner +globals()['EmployeeTeam'] = EmployeeTeam +globals()['Gender'] = Gender +globals()['PhoneNumber'] = PhoneNumber +from apideck.model.employee import Employee + + +class TestEmployee(unittest.TestCase): + """Employee unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testEmployee(self): + """Test Employee""" + # FIXME: construct object with mandatory attributes with example values + # model = Employee() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_employee_compensations.py b/src/test/test_employee_compensations.py new file mode 100644 index 0000000000..6e6e36303d --- /dev/null +++ b/src/test/test_employee_compensations.py @@ -0,0 +1,39 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.currency import Currency +from apideck.model.payment_unit import PaymentUnit +globals()['Currency'] = Currency +globals()['PaymentUnit'] = PaymentUnit +from apideck.model.employee_compensations import EmployeeCompensations + + +class TestEmployeeCompensations(unittest.TestCase): + """EmployeeCompensations unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testEmployeeCompensations(self): + """Test EmployeeCompensations""" + # FIXME: construct object with mandatory attributes with example values + # model = EmployeeCompensations() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_employee_employment_role.py b/src/test/test_employee_employment_role.py new file mode 100644 index 0000000000..9a06d45484 --- /dev/null +++ b/src/test/test_employee_employment_role.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.employee_employment_role import EmployeeEmploymentRole + + +class TestEmployeeEmploymentRole(unittest.TestCase): + """EmployeeEmploymentRole unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testEmployeeEmploymentRole(self): + """Test EmployeeEmploymentRole""" + # FIXME: construct object with mandatory attributes with example values + # model = EmployeeEmploymentRole() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_employee_jobs.py b/src/test/test_employee_jobs.py new file mode 100644 index 0000000000..e36db31c68 --- /dev/null +++ b/src/test/test_employee_jobs.py @@ -0,0 +1,41 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.address import Address +from apideck.model.currency import Currency +from apideck.model.payment_unit import PaymentUnit +globals()['Address'] = Address +globals()['Currency'] = Currency +globals()['PaymentUnit'] = PaymentUnit +from apideck.model.employee_jobs import EmployeeJobs + + +class TestEmployeeJobs(unittest.TestCase): + """EmployeeJobs unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testEmployeeJobs(self): + """Test EmployeeJobs""" + # FIXME: construct object with mandatory attributes with example values + # model = EmployeeJobs() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_employee_manager.py b/src/test/test_employee_manager.py new file mode 100644 index 0000000000..e1f0335c01 --- /dev/null +++ b/src/test/test_employee_manager.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.employee_manager import EmployeeManager + + +class TestEmployeeManager(unittest.TestCase): + """EmployeeManager unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testEmployeeManager(self): + """Test EmployeeManager""" + # FIXME: construct object with mandatory attributes with example values + # model = EmployeeManager() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_employee_partner.py b/src/test/test_employee_partner.py new file mode 100644 index 0000000000..245c34178e --- /dev/null +++ b/src/test/test_employee_partner.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.gender import Gender +globals()['Gender'] = Gender +from apideck.model.employee_partner import EmployeePartner + + +class TestEmployeePartner(unittest.TestCase): + """EmployeePartner unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testEmployeePartner(self): + """Test EmployeePartner""" + # FIXME: construct object with mandatory attributes with example values + # model = EmployeePartner() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_employee_payroll.py b/src/test/test_employee_payroll.py new file mode 100644 index 0000000000..27a88dca0c --- /dev/null +++ b/src/test/test_employee_payroll.py @@ -0,0 +1,39 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.employee import Employee +from apideck.model.payroll import Payroll +globals()['Employee'] = Employee +globals()['Payroll'] = Payroll +from apideck.model.employee_payroll import EmployeePayroll + + +class TestEmployeePayroll(unittest.TestCase): + """EmployeePayroll unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testEmployeePayroll(self): + """Test EmployeePayroll""" + # FIXME: construct object with mandatory attributes with example values + # model = EmployeePayroll() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_employee_payrolls.py b/src/test/test_employee_payrolls.py new file mode 100644 index 0000000000..434555e69a --- /dev/null +++ b/src/test/test_employee_payrolls.py @@ -0,0 +1,39 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.employee import Employee +from apideck.model.payroll import Payroll +globals()['Employee'] = Employee +globals()['Payroll'] = Payroll +from apideck.model.employee_payrolls import EmployeePayrolls + + +class TestEmployeePayrolls(unittest.TestCase): + """EmployeePayrolls unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testEmployeePayrolls(self): + """Test EmployeePayrolls""" + # FIXME: construct object with mandatory attributes with example values + # model = EmployeePayrolls() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_employee_schedules.py b/src/test/test_employee_schedules.py new file mode 100644 index 0000000000..488bf83a17 --- /dev/null +++ b/src/test/test_employee_schedules.py @@ -0,0 +1,39 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.employee import Employee +from apideck.model.schedule import Schedule +globals()['Employee'] = Employee +globals()['Schedule'] = Schedule +from apideck.model.employee_schedules import EmployeeSchedules + + +class TestEmployeeSchedules(unittest.TestCase): + """EmployeeSchedules unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testEmployeeSchedules(self): + """Test EmployeeSchedules""" + # FIXME: construct object with mandatory attributes with example values + # model = EmployeeSchedules() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_employee_team.py b/src/test/test_employee_team.py new file mode 100644 index 0000000000..e2894ca6ff --- /dev/null +++ b/src/test/test_employee_team.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.employee_team import EmployeeTeam + + +class TestEmployeeTeam(unittest.TestCase): + """EmployeeTeam unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testEmployeeTeam(self): + """Test EmployeeTeam""" + # FIXME: construct object with mandatory attributes with example values + # model = EmployeeTeam() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_employees_filter.py b/src/test/test_employees_filter.py new file mode 100644 index 0000000000..712ca1e64a --- /dev/null +++ b/src/test/test_employees_filter.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.employees_filter import EmployeesFilter + + +class TestEmployeesFilter(unittest.TestCase): + """EmployeesFilter unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testEmployeesFilter(self): + """Test EmployeesFilter""" + # FIXME: construct object with mandatory attributes with example values + # model = EmployeesFilter() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_error.py b/src/test/test_error.py new file mode 100644 index 0000000000..653975f60a --- /dev/null +++ b/src/test/test_error.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.error import Error + + +class TestError(unittest.TestCase): + """Error unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testError(self): + """Test Error""" + # FIXME: construct object with mandatory attributes with example values + # model = Error() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_execute_base_url.py b/src/test/test_execute_base_url.py new file mode 100644 index 0000000000..f9871290a5 --- /dev/null +++ b/src/test/test_execute_base_url.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.execute_base_url import ExecuteBaseUrl + + +class TestExecuteBaseUrl(unittest.TestCase): + """ExecuteBaseUrl unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testExecuteBaseUrl(self): + """Test ExecuteBaseUrl""" + # FIXME: construct object with mandatory attributes with example values + # model = ExecuteBaseUrl() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_execute_webhook_event_request.py b/src/test/test_execute_webhook_event_request.py new file mode 100644 index 0000000000..7472dfb9dd --- /dev/null +++ b/src/test/test_execute_webhook_event_request.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.execute_webhook_event_request import ExecuteWebhookEventRequest + + +class TestExecuteWebhookEventRequest(unittest.TestCase): + """ExecuteWebhookEventRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testExecuteWebhookEventRequest(self): + """Test ExecuteWebhookEventRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = ExecuteWebhookEventRequest() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_execute_webhook_events_request.py b/src/test/test_execute_webhook_events_request.py new file mode 100644 index 0000000000..92b091ca48 --- /dev/null +++ b/src/test/test_execute_webhook_events_request.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.execute_webhook_events_request import ExecuteWebhookEventsRequest + + +class TestExecuteWebhookEventsRequest(unittest.TestCase): + """ExecuteWebhookEventsRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testExecuteWebhookEventsRequest(self): + """Test ExecuteWebhookEventsRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = ExecuteWebhookEventsRequest() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_execute_webhook_response.py b/src/test/test_execute_webhook_response.py new file mode 100644 index 0000000000..a21da36adc --- /dev/null +++ b/src/test/test_execute_webhook_response.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.execute_webhook_response import ExecuteWebhookResponse + + +class TestExecuteWebhookResponse(unittest.TestCase): + """ExecuteWebhookResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testExecuteWebhookResponse(self): + """Test ExecuteWebhookResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = ExecuteWebhookResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_file_storage_api.py b/src/test/test_file_storage_api.py new file mode 100644 index 0000000000..0305130786 --- /dev/null +++ b/src/test/test_file_storage_api.py @@ -0,0 +1,231 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import apideck +from apideck.api.file_storage_api import FileStorageApi # noqa: E501 + + +class TestFileStorageApi(unittest.TestCase): + """FileStorageApi unit test stubs""" + + def setUp(self): + self.api = FileStorageApi() # noqa: E501 + + def tearDown(self): + pass + + def test_drive_groups_add(self): + """Test case for drive_groups_add + + Create DriveGroup # noqa: E501 + """ + pass + + def test_drive_groups_all(self): + """Test case for drive_groups_all + + List DriveGroups # noqa: E501 + """ + pass + + def test_drive_groups_delete(self): + """Test case for drive_groups_delete + + Delete DriveGroup # noqa: E501 + """ + pass + + def test_drive_groups_one(self): + """Test case for drive_groups_one + + Get DriveGroup # noqa: E501 + """ + pass + + def test_drive_groups_update(self): + """Test case for drive_groups_update + + Update DriveGroup # noqa: E501 + """ + pass + + def test_drives_add(self): + """Test case for drives_add + + Create Drive # noqa: E501 + """ + pass + + def test_drives_all(self): + """Test case for drives_all + + List Drives # noqa: E501 + """ + pass + + def test_drives_delete(self): + """Test case for drives_delete + + Delete Drive # noqa: E501 + """ + pass + + def test_drives_one(self): + """Test case for drives_one + + Get Drive # noqa: E501 + """ + pass + + def test_drives_update(self): + """Test case for drives_update + + Update Drive # noqa: E501 + """ + pass + + def test_files_all(self): + """Test case for files_all + + List Files # noqa: E501 + """ + pass + + def test_files_delete(self): + """Test case for files_delete + + Delete File # noqa: E501 + """ + pass + + def test_files_download(self): + """Test case for files_download + + Download File # noqa: E501 + """ + pass + + def test_files_one(self): + """Test case for files_one + + Get File # noqa: E501 + """ + pass + + def test_files_search(self): + """Test case for files_search + + Search Files # noqa: E501 + """ + pass + + def test_folders_add(self): + """Test case for folders_add + + Create Folder # noqa: E501 + """ + pass + + def test_folders_copy(self): + """Test case for folders_copy + + Copy Folder # noqa: E501 + """ + pass + + def test_folders_delete(self): + """Test case for folders_delete + + Delete Folder # noqa: E501 + """ + pass + + def test_folders_one(self): + """Test case for folders_one + + Get Folder # noqa: E501 + """ + pass + + def test_folders_update(self): + """Test case for folders_update + + Rename or move Folder # noqa: E501 + """ + pass + + def test_shared_links_add(self): + """Test case for shared_links_add + + Create Shared Link # noqa: E501 + """ + pass + + def test_shared_links_all(self): + """Test case for shared_links_all + + List SharedLinks # noqa: E501 + """ + pass + + def test_shared_links_delete(self): + """Test case for shared_links_delete + + Delete Shared Link # noqa: E501 + """ + pass + + def test_shared_links_one(self): + """Test case for shared_links_one + + Get Shared Link # noqa: E501 + """ + pass + + def test_shared_links_update(self): + """Test case for shared_links_update + + Update Shared Link # noqa: E501 + """ + pass + + def test_upload_sessions_add(self): + """Test case for upload_sessions_add + + Start Upload Session # noqa: E501 + """ + pass + + def test_upload_sessions_delete(self): + """Test case for upload_sessions_delete + + Abort Upload Session # noqa: E501 + """ + pass + + def test_upload_sessions_finish(self): + """Test case for upload_sessions_finish + + Finish Upload Session # noqa: E501 + """ + pass + + def test_upload_sessions_one(self): + """Test case for upload_sessions_one + + Get Upload Session # noqa: E501 + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_file_storage_event_type.py b/src/test/test_file_storage_event_type.py new file mode 100644 index 0000000000..a79b8bb259 --- /dev/null +++ b/src/test/test_file_storage_event_type.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.file_storage_event_type import FileStorageEventType + + +class TestFileStorageEventType(unittest.TestCase): + """FileStorageEventType unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testFileStorageEventType(self): + """Test FileStorageEventType""" + # FIXME: construct object with mandatory attributes with example values + # model = FileStorageEventType() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_file_type.py b/src/test/test_file_type.py new file mode 100644 index 0000000000..57f62d03d5 --- /dev/null +++ b/src/test/test_file_type.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.file_type import FileType + + +class TestFileType(unittest.TestCase): + """FileType unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testFileType(self): + """Test FileType""" + # FIXME: construct object with mandatory attributes with example values + # model = FileType() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_files_filter.py b/src/test/test_files_filter.py new file mode 100644 index 0000000000..2a9c969ec5 --- /dev/null +++ b/src/test/test_files_filter.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.files_filter import FilesFilter + + +class TestFilesFilter(unittest.TestCase): + """FilesFilter unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testFilesFilter(self): + """Test FilesFilter""" + # FIXME: construct object with mandatory attributes with example values + # model = FilesFilter() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_files_search.py b/src/test/test_files_search.py new file mode 100644 index 0000000000..f1ca6d1e2a --- /dev/null +++ b/src/test/test_files_search.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.files_search import FilesSearch + + +class TestFilesSearch(unittest.TestCase): + """FilesSearch unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testFilesSearch(self): + """Test FilesSearch""" + # FIXME: construct object with mandatory attributes with example values + # model = FilesSearch() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_files_sort.py b/src/test/test_files_sort.py new file mode 100644 index 0000000000..669329093a --- /dev/null +++ b/src/test/test_files_sort.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.sort_direction import SortDirection +globals()['SortDirection'] = SortDirection +from apideck.model.files_sort import FilesSort + + +class TestFilesSort(unittest.TestCase): + """FilesSort unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testFilesSort(self): + """Test FilesSort""" + # FIXME: construct object with mandatory attributes with example values + # model = FilesSort() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_folder.py b/src/test/test_folder.py new file mode 100644 index 0000000000..5243e470ae --- /dev/null +++ b/src/test/test_folder.py @@ -0,0 +1,39 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.linked_folder import LinkedFolder +from apideck.model.owner import Owner +globals()['LinkedFolder'] = LinkedFolder +globals()['Owner'] = Owner +from apideck.model.folder import Folder + + +class TestFolder(unittest.TestCase): + """Folder unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testFolder(self): + """Test Folder""" + # FIXME: construct object with mandatory attributes with example values + # model = Folder() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_form_field.py b/src/test/test_form_field.py new file mode 100644 index 0000000000..82749769c9 --- /dev/null +++ b/src/test/test_form_field.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.form_field_option import FormFieldOption +globals()['FormFieldOption'] = FormFieldOption +from apideck.model.form_field import FormField + + +class TestFormField(unittest.TestCase): + """FormField unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testFormField(self): + """Test FormField""" + # FIXME: construct object with mandatory attributes with example values + # model = FormField() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_form_field_option.py b/src/test/test_form_field_option.py new file mode 100644 index 0000000000..410a08a6c4 --- /dev/null +++ b/src/test/test_form_field_option.py @@ -0,0 +1,39 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.form_field_option_group import FormFieldOptionGroup +from apideck.model.simple_form_field_option import SimpleFormFieldOption +globals()['FormFieldOptionGroup'] = FormFieldOptionGroup +globals()['SimpleFormFieldOption'] = SimpleFormFieldOption +from apideck.model.form_field_option import FormFieldOption + + +class TestFormFieldOption(unittest.TestCase): + """FormFieldOption unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testFormFieldOption(self): + """Test FormFieldOption""" + # FIXME: construct object with mandatory attributes with example values + # model = FormFieldOption() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_form_field_option_group.py b/src/test/test_form_field_option_group.py new file mode 100644 index 0000000000..467aafc15d --- /dev/null +++ b/src/test/test_form_field_option_group.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.simple_form_field_option import SimpleFormFieldOption +globals()['SimpleFormFieldOption'] = SimpleFormFieldOption +from apideck.model.form_field_option_group import FormFieldOptionGroup + + +class TestFormFieldOptionGroup(unittest.TestCase): + """FormFieldOptionGroup unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testFormFieldOptionGroup(self): + """Test FormFieldOptionGroup""" + # FIXME: construct object with mandatory attributes with example values + # model = FormFieldOptionGroup() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_gender.py b/src/test/test_gender.py new file mode 100644 index 0000000000..cd0be81667 --- /dev/null +++ b/src/test/test_gender.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.gender import Gender + + +class TestGender(unittest.TestCase): + """Gender unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGender(self): + """Test Gender""" + # FIXME: construct object with mandatory attributes with example values + # model = Gender() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_get_activities_response.py b/src/test/test_get_activities_response.py new file mode 100644 index 0000000000..49e995e6ee --- /dev/null +++ b/src/test/test_get_activities_response.py @@ -0,0 +1,41 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.activity import Activity +from apideck.model.links import Links +from apideck.model.meta import Meta +globals()['Activity'] = Activity +globals()['Links'] = Links +globals()['Meta'] = Meta +from apideck.model.get_activities_response import GetActivitiesResponse + + +class TestGetActivitiesResponse(unittest.TestCase): + """GetActivitiesResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGetActivitiesResponse(self): + """Test GetActivitiesResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = GetActivitiesResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_get_activity_response.py b/src/test/test_get_activity_response.py new file mode 100644 index 0000000000..275994a6a0 --- /dev/null +++ b/src/test/test_get_activity_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.activity import Activity +globals()['Activity'] = Activity +from apideck.model.get_activity_response import GetActivityResponse + + +class TestGetActivityResponse(unittest.TestCase): + """GetActivityResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGetActivityResponse(self): + """Test GetActivityResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = GetActivityResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_get_api_resource_coverage_response.py b/src/test/test_get_api_resource_coverage_response.py new file mode 100644 index 0000000000..babedec4dc --- /dev/null +++ b/src/test/test_get_api_resource_coverage_response.py @@ -0,0 +1,41 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.api_resource_coverage import ApiResourceCoverage +from apideck.model.links import Links +from apideck.model.meta import Meta +globals()['ApiResourceCoverage'] = ApiResourceCoverage +globals()['Links'] = Links +globals()['Meta'] = Meta +from apideck.model.get_api_resource_coverage_response import GetApiResourceCoverageResponse + + +class TestGetApiResourceCoverageResponse(unittest.TestCase): + """GetApiResourceCoverageResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGetApiResourceCoverageResponse(self): + """Test GetApiResourceCoverageResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = GetApiResourceCoverageResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_get_api_resource_response.py b/src/test/test_get_api_resource_response.py new file mode 100644 index 0000000000..2f69c7041b --- /dev/null +++ b/src/test/test_get_api_resource_response.py @@ -0,0 +1,41 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.api_resource import ApiResource +from apideck.model.links import Links +from apideck.model.meta import Meta +globals()['ApiResource'] = ApiResource +globals()['Links'] = Links +globals()['Meta'] = Meta +from apideck.model.get_api_resource_response import GetApiResourceResponse + + +class TestGetApiResourceResponse(unittest.TestCase): + """GetApiResourceResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGetApiResourceResponse(self): + """Test GetApiResourceResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = GetApiResourceResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_get_api_response.py b/src/test/test_get_api_response.py new file mode 100644 index 0000000000..d5d905903e --- /dev/null +++ b/src/test/test_get_api_response.py @@ -0,0 +1,41 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.api import Api +from apideck.model.links import Links +from apideck.model.meta import Meta +globals()['Api'] = Api +globals()['Links'] = Links +globals()['Meta'] = Meta +from apideck.model.get_api_response import GetApiResponse + + +class TestGetApiResponse(unittest.TestCase): + """GetApiResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGetApiResponse(self): + """Test GetApiResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = GetApiResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_get_apis_response.py b/src/test/test_get_apis_response.py new file mode 100644 index 0000000000..7ddf7faf3b --- /dev/null +++ b/src/test/test_get_apis_response.py @@ -0,0 +1,41 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.api import Api +from apideck.model.links import Links +from apideck.model.meta import Meta +globals()['Api'] = Api +globals()['Links'] = Links +globals()['Meta'] = Meta +from apideck.model.get_apis_response import GetApisResponse + + +class TestGetApisResponse(unittest.TestCase): + """GetApisResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGetApisResponse(self): + """Test GetApisResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = GetApisResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_get_applicant_response.py b/src/test/test_get_applicant_response.py new file mode 100644 index 0000000000..0c4aad4e74 --- /dev/null +++ b/src/test/test_get_applicant_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.applicant import Applicant +globals()['Applicant'] = Applicant +from apideck.model.get_applicant_response import GetApplicantResponse + + +class TestGetApplicantResponse(unittest.TestCase): + """GetApplicantResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGetApplicantResponse(self): + """Test GetApplicantResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = GetApplicantResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_get_applicants_response.py b/src/test/test_get_applicants_response.py new file mode 100644 index 0000000000..9febfdcbd4 --- /dev/null +++ b/src/test/test_get_applicants_response.py @@ -0,0 +1,41 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.applicant import Applicant +from apideck.model.links import Links +from apideck.model.meta import Meta +globals()['Applicant'] = Applicant +globals()['Links'] = Links +globals()['Meta'] = Meta +from apideck.model.get_applicants_response import GetApplicantsResponse + + +class TestGetApplicantsResponse(unittest.TestCase): + """GetApplicantsResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGetApplicantsResponse(self): + """Test GetApplicantsResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = GetApplicantsResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_get_balance_sheet_response.py b/src/test/test_get_balance_sheet_response.py new file mode 100644 index 0000000000..2da0cc7db0 --- /dev/null +++ b/src/test/test_get_balance_sheet_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.balance_sheet import BalanceSheet +globals()['BalanceSheet'] = BalanceSheet +from apideck.model.get_balance_sheet_response import GetBalanceSheetResponse + + +class TestGetBalanceSheetResponse(unittest.TestCase): + """GetBalanceSheetResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGetBalanceSheetResponse(self): + """Test GetBalanceSheetResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = GetBalanceSheetResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_get_bill_response.py b/src/test/test_get_bill_response.py new file mode 100644 index 0000000000..e437150fa8 --- /dev/null +++ b/src/test/test_get_bill_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.bill import Bill +globals()['Bill'] = Bill +from apideck.model.get_bill_response import GetBillResponse + + +class TestGetBillResponse(unittest.TestCase): + """GetBillResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGetBillResponse(self): + """Test GetBillResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = GetBillResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_get_bills_response.py b/src/test/test_get_bills_response.py new file mode 100644 index 0000000000..b523152b31 --- /dev/null +++ b/src/test/test_get_bills_response.py @@ -0,0 +1,41 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.bill import Bill +from apideck.model.links import Links +from apideck.model.meta import Meta +globals()['Bill'] = Bill +globals()['Links'] = Links +globals()['Meta'] = Meta +from apideck.model.get_bills_response import GetBillsResponse + + +class TestGetBillsResponse(unittest.TestCase): + """GetBillsResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGetBillsResponse(self): + """Test GetBillsResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = GetBillsResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_get_companies_response.py b/src/test/test_get_companies_response.py new file mode 100644 index 0000000000..e4b6474b36 --- /dev/null +++ b/src/test/test_get_companies_response.py @@ -0,0 +1,41 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.company import Company +from apideck.model.links import Links +from apideck.model.meta import Meta +globals()['Company'] = Company +globals()['Links'] = Links +globals()['Meta'] = Meta +from apideck.model.get_companies_response import GetCompaniesResponse + + +class TestGetCompaniesResponse(unittest.TestCase): + """GetCompaniesResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGetCompaniesResponse(self): + """Test GetCompaniesResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = GetCompaniesResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_get_company_info_response.py b/src/test/test_get_company_info_response.py new file mode 100644 index 0000000000..7dd5154178 --- /dev/null +++ b/src/test/test_get_company_info_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.company_info import CompanyInfo +globals()['CompanyInfo'] = CompanyInfo +from apideck.model.get_company_info_response import GetCompanyInfoResponse + + +class TestGetCompanyInfoResponse(unittest.TestCase): + """GetCompanyInfoResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGetCompanyInfoResponse(self): + """Test GetCompanyInfoResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = GetCompanyInfoResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_get_company_response.py b/src/test/test_get_company_response.py new file mode 100644 index 0000000000..0599bff097 --- /dev/null +++ b/src/test/test_get_company_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.company import Company +globals()['Company'] = Company +from apideck.model.get_company_response import GetCompanyResponse + + +class TestGetCompanyResponse(unittest.TestCase): + """GetCompanyResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGetCompanyResponse(self): + """Test GetCompanyResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = GetCompanyResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_get_connection_response.py b/src/test/test_get_connection_response.py new file mode 100644 index 0000000000..db64c9398f --- /dev/null +++ b/src/test/test_get_connection_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.connection import Connection +globals()['Connection'] = Connection +from apideck.model.get_connection_response import GetConnectionResponse + + +class TestGetConnectionResponse(unittest.TestCase): + """GetConnectionResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGetConnectionResponse(self): + """Test GetConnectionResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = GetConnectionResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_get_connections_response.py b/src/test/test_get_connections_response.py new file mode 100644 index 0000000000..9cba68921d --- /dev/null +++ b/src/test/test_get_connections_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.connection import Connection +globals()['Connection'] = Connection +from apideck.model.get_connections_response import GetConnectionsResponse + + +class TestGetConnectionsResponse(unittest.TestCase): + """GetConnectionsResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGetConnectionsResponse(self): + """Test GetConnectionsResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = GetConnectionsResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_get_connector_resource_response.py b/src/test/test_get_connector_resource_response.py new file mode 100644 index 0000000000..1280def0b9 --- /dev/null +++ b/src/test/test_get_connector_resource_response.py @@ -0,0 +1,41 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.connector_resource import ConnectorResource +from apideck.model.links import Links +from apideck.model.meta import Meta +globals()['ConnectorResource'] = ConnectorResource +globals()['Links'] = Links +globals()['Meta'] = Meta +from apideck.model.get_connector_resource_response import GetConnectorResourceResponse + + +class TestGetConnectorResourceResponse(unittest.TestCase): + """GetConnectorResourceResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGetConnectorResourceResponse(self): + """Test GetConnectorResourceResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = GetConnectorResourceResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_get_connector_response.py b/src/test/test_get_connector_response.py new file mode 100644 index 0000000000..51545627bc --- /dev/null +++ b/src/test/test_get_connector_response.py @@ -0,0 +1,41 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.connector import Connector +from apideck.model.links import Links +from apideck.model.meta import Meta +globals()['Connector'] = Connector +globals()['Links'] = Links +globals()['Meta'] = Meta +from apideck.model.get_connector_response import GetConnectorResponse + + +class TestGetConnectorResponse(unittest.TestCase): + """GetConnectorResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGetConnectorResponse(self): + """Test GetConnectorResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = GetConnectorResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_get_connectors_response.py b/src/test/test_get_connectors_response.py new file mode 100644 index 0000000000..92d4349862 --- /dev/null +++ b/src/test/test_get_connectors_response.py @@ -0,0 +1,41 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.connector import Connector +from apideck.model.links import Links +from apideck.model.meta import Meta +globals()['Connector'] = Connector +globals()['Links'] = Links +globals()['Meta'] = Meta +from apideck.model.get_connectors_response import GetConnectorsResponse + + +class TestGetConnectorsResponse(unittest.TestCase): + """GetConnectorsResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGetConnectorsResponse(self): + """Test GetConnectorsResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = GetConnectorsResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_get_consumer_response.py b/src/test/test_get_consumer_response.py new file mode 100644 index 0000000000..a8ee523f41 --- /dev/null +++ b/src/test/test_get_consumer_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.consumer import Consumer +globals()['Consumer'] = Consumer +from apideck.model.get_consumer_response import GetConsumerResponse + + +class TestGetConsumerResponse(unittest.TestCase): + """GetConsumerResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGetConsumerResponse(self): + """Test GetConsumerResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = GetConsumerResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_get_consumers_response.py b/src/test/test_get_consumers_response.py new file mode 100644 index 0000000000..0971aed6ad --- /dev/null +++ b/src/test/test_get_consumers_response.py @@ -0,0 +1,41 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.get_consumers_response_data import GetConsumersResponseData +from apideck.model.links import Links +from apideck.model.meta import Meta +globals()['GetConsumersResponseData'] = GetConsumersResponseData +globals()['Links'] = Links +globals()['Meta'] = Meta +from apideck.model.get_consumers_response import GetConsumersResponse + + +class TestGetConsumersResponse(unittest.TestCase): + """GetConsumersResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGetConsumersResponse(self): + """Test GetConsumersResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = GetConsumersResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_get_consumers_response_data.py b/src/test/test_get_consumers_response_data.py new file mode 100644 index 0000000000..9fac85414e --- /dev/null +++ b/src/test/test_get_consumers_response_data.py @@ -0,0 +1,39 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.consumer_metadata import ConsumerMetadata +from apideck.model.request_count_allocation import RequestCountAllocation +globals()['ConsumerMetadata'] = ConsumerMetadata +globals()['RequestCountAllocation'] = RequestCountAllocation +from apideck.model.get_consumers_response_data import GetConsumersResponseData + + +class TestGetConsumersResponseData(unittest.TestCase): + """GetConsumersResponseData unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGetConsumersResponseData(self): + """Test GetConsumersResponseData""" + # FIXME: construct object with mandatory attributes with example values + # model = GetConsumersResponseData() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_get_contact_response.py b/src/test/test_get_contact_response.py new file mode 100644 index 0000000000..504a406e8c --- /dev/null +++ b/src/test/test_get_contact_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.contact import Contact +globals()['Contact'] = Contact +from apideck.model.get_contact_response import GetContactResponse + + +class TestGetContactResponse(unittest.TestCase): + """GetContactResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGetContactResponse(self): + """Test GetContactResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = GetContactResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_get_contacts_response.py b/src/test/test_get_contacts_response.py new file mode 100644 index 0000000000..bed2d47c7b --- /dev/null +++ b/src/test/test_get_contacts_response.py @@ -0,0 +1,41 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.contact import Contact +from apideck.model.links import Links +from apideck.model.meta import Meta +globals()['Contact'] = Contact +globals()['Links'] = Links +globals()['Meta'] = Meta +from apideck.model.get_contacts_response import GetContactsResponse + + +class TestGetContactsResponse(unittest.TestCase): + """GetContactsResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGetContactsResponse(self): + """Test GetContactsResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = GetContactsResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_get_credit_note_response.py b/src/test/test_get_credit_note_response.py new file mode 100644 index 0000000000..c1511e399c --- /dev/null +++ b/src/test/test_get_credit_note_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.credit_note import CreditNote +globals()['CreditNote'] = CreditNote +from apideck.model.get_credit_note_response import GetCreditNoteResponse + + +class TestGetCreditNoteResponse(unittest.TestCase): + """GetCreditNoteResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGetCreditNoteResponse(self): + """Test GetCreditNoteResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = GetCreditNoteResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_get_credit_notes_response.py b/src/test/test_get_credit_notes_response.py new file mode 100644 index 0000000000..b2bb49b9ac --- /dev/null +++ b/src/test/test_get_credit_notes_response.py @@ -0,0 +1,41 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.credit_note import CreditNote +from apideck.model.links import Links +from apideck.model.meta import Meta +globals()['CreditNote'] = CreditNote +globals()['Links'] = Links +globals()['Meta'] = Meta +from apideck.model.get_credit_notes_response import GetCreditNotesResponse + + +class TestGetCreditNotesResponse(unittest.TestCase): + """GetCreditNotesResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGetCreditNotesResponse(self): + """Test GetCreditNotesResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = GetCreditNotesResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_get_customer_response.py b/src/test/test_get_customer_response.py new file mode 100644 index 0000000000..8f1396421d --- /dev/null +++ b/src/test/test_get_customer_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.accounting_customer import AccountingCustomer +globals()['AccountingCustomer'] = AccountingCustomer +from apideck.model.get_customer_response import GetCustomerResponse + + +class TestGetCustomerResponse(unittest.TestCase): + """GetCustomerResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGetCustomerResponse(self): + """Test GetCustomerResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = GetCustomerResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_get_customer_support_customer_response.py b/src/test/test_get_customer_support_customer_response.py new file mode 100644 index 0000000000..dc183900f7 --- /dev/null +++ b/src/test/test_get_customer_support_customer_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.customer_support_customer import CustomerSupportCustomer +globals()['CustomerSupportCustomer'] = CustomerSupportCustomer +from apideck.model.get_customer_support_customer_response import GetCustomerSupportCustomerResponse + + +class TestGetCustomerSupportCustomerResponse(unittest.TestCase): + """GetCustomerSupportCustomerResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGetCustomerSupportCustomerResponse(self): + """Test GetCustomerSupportCustomerResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = GetCustomerSupportCustomerResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_get_customer_support_customers_response.py b/src/test/test_get_customer_support_customers_response.py new file mode 100644 index 0000000000..465a56d6f4 --- /dev/null +++ b/src/test/test_get_customer_support_customers_response.py @@ -0,0 +1,41 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.customer_support_customer import CustomerSupportCustomer +from apideck.model.links import Links +from apideck.model.meta import Meta +globals()['CustomerSupportCustomer'] = CustomerSupportCustomer +globals()['Links'] = Links +globals()['Meta'] = Meta +from apideck.model.get_customer_support_customers_response import GetCustomerSupportCustomersResponse + + +class TestGetCustomerSupportCustomersResponse(unittest.TestCase): + """GetCustomerSupportCustomersResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGetCustomerSupportCustomersResponse(self): + """Test GetCustomerSupportCustomersResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = GetCustomerSupportCustomersResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_get_customers_response.py b/src/test/test_get_customers_response.py new file mode 100644 index 0000000000..5ca1421be4 --- /dev/null +++ b/src/test/test_get_customers_response.py @@ -0,0 +1,41 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.accounting_customer import AccountingCustomer +from apideck.model.links import Links +from apideck.model.meta import Meta +globals()['AccountingCustomer'] = AccountingCustomer +globals()['Links'] = Links +globals()['Meta'] = Meta +from apideck.model.get_customers_response import GetCustomersResponse + + +class TestGetCustomersResponse(unittest.TestCase): + """GetCustomersResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGetCustomersResponse(self): + """Test GetCustomersResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = GetCustomersResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_get_department_response.py b/src/test/test_get_department_response.py new file mode 100644 index 0000000000..c88bf6b40f --- /dev/null +++ b/src/test/test_get_department_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.department import Department +globals()['Department'] = Department +from apideck.model.get_department_response import GetDepartmentResponse + + +class TestGetDepartmentResponse(unittest.TestCase): + """GetDepartmentResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGetDepartmentResponse(self): + """Test GetDepartmentResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = GetDepartmentResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_get_departments_response.py b/src/test/test_get_departments_response.py new file mode 100644 index 0000000000..67e561c3af --- /dev/null +++ b/src/test/test_get_departments_response.py @@ -0,0 +1,41 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.department import Department +from apideck.model.links import Links +from apideck.model.meta import Meta +globals()['Department'] = Department +globals()['Links'] = Links +globals()['Meta'] = Meta +from apideck.model.get_departments_response import GetDepartmentsResponse + + +class TestGetDepartmentsResponse(unittest.TestCase): + """GetDepartmentsResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGetDepartmentsResponse(self): + """Test GetDepartmentsResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = GetDepartmentsResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_get_drive_group_response.py b/src/test/test_get_drive_group_response.py new file mode 100644 index 0000000000..702d9a667a --- /dev/null +++ b/src/test/test_get_drive_group_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.drive_group import DriveGroup +globals()['DriveGroup'] = DriveGroup +from apideck.model.get_drive_group_response import GetDriveGroupResponse + + +class TestGetDriveGroupResponse(unittest.TestCase): + """GetDriveGroupResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGetDriveGroupResponse(self): + """Test GetDriveGroupResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = GetDriveGroupResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_get_drive_groups_response.py b/src/test/test_get_drive_groups_response.py new file mode 100644 index 0000000000..bc068662be --- /dev/null +++ b/src/test/test_get_drive_groups_response.py @@ -0,0 +1,41 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.drive_group import DriveGroup +from apideck.model.links import Links +from apideck.model.meta import Meta +globals()['DriveGroup'] = DriveGroup +globals()['Links'] = Links +globals()['Meta'] = Meta +from apideck.model.get_drive_groups_response import GetDriveGroupsResponse + + +class TestGetDriveGroupsResponse(unittest.TestCase): + """GetDriveGroupsResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGetDriveGroupsResponse(self): + """Test GetDriveGroupsResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = GetDriveGroupsResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_get_drive_response.py b/src/test/test_get_drive_response.py new file mode 100644 index 0000000000..6843a7128d --- /dev/null +++ b/src/test/test_get_drive_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.drive import Drive +globals()['Drive'] = Drive +from apideck.model.get_drive_response import GetDriveResponse + + +class TestGetDriveResponse(unittest.TestCase): + """GetDriveResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGetDriveResponse(self): + """Test GetDriveResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = GetDriveResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_get_drives_response.py b/src/test/test_get_drives_response.py new file mode 100644 index 0000000000..87e3b00e60 --- /dev/null +++ b/src/test/test_get_drives_response.py @@ -0,0 +1,41 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.drive import Drive +from apideck.model.links import Links +from apideck.model.meta import Meta +globals()['Drive'] = Drive +globals()['Links'] = Links +globals()['Meta'] = Meta +from apideck.model.get_drives_response import GetDrivesResponse + + +class TestGetDrivesResponse(unittest.TestCase): + """GetDrivesResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGetDrivesResponse(self): + """Test GetDrivesResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = GetDrivesResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_get_employee_payroll_response.py b/src/test/test_get_employee_payroll_response.py new file mode 100644 index 0000000000..6f95e2ce96 --- /dev/null +++ b/src/test/test_get_employee_payroll_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.employee_payroll import EmployeePayroll +globals()['EmployeePayroll'] = EmployeePayroll +from apideck.model.get_employee_payroll_response import GetEmployeePayrollResponse + + +class TestGetEmployeePayrollResponse(unittest.TestCase): + """GetEmployeePayrollResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGetEmployeePayrollResponse(self): + """Test GetEmployeePayrollResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = GetEmployeePayrollResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_get_employee_payrolls_response.py b/src/test/test_get_employee_payrolls_response.py new file mode 100644 index 0000000000..e14fee6178 --- /dev/null +++ b/src/test/test_get_employee_payrolls_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.employee_payrolls import EmployeePayrolls +globals()['EmployeePayrolls'] = EmployeePayrolls +from apideck.model.get_employee_payrolls_response import GetEmployeePayrollsResponse + + +class TestGetEmployeePayrollsResponse(unittest.TestCase): + """GetEmployeePayrollsResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGetEmployeePayrollsResponse(self): + """Test GetEmployeePayrollsResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = GetEmployeePayrollsResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_get_employee_response.py b/src/test/test_get_employee_response.py new file mode 100644 index 0000000000..45a9d69f90 --- /dev/null +++ b/src/test/test_get_employee_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.employee import Employee +globals()['Employee'] = Employee +from apideck.model.get_employee_response import GetEmployeeResponse + + +class TestGetEmployeeResponse(unittest.TestCase): + """GetEmployeeResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGetEmployeeResponse(self): + """Test GetEmployeeResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = GetEmployeeResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_get_employee_schedules_response.py b/src/test/test_get_employee_schedules_response.py new file mode 100644 index 0000000000..357868c3da --- /dev/null +++ b/src/test/test_get_employee_schedules_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.employee_schedules import EmployeeSchedules +globals()['EmployeeSchedules'] = EmployeeSchedules +from apideck.model.get_employee_schedules_response import GetEmployeeSchedulesResponse + + +class TestGetEmployeeSchedulesResponse(unittest.TestCase): + """GetEmployeeSchedulesResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGetEmployeeSchedulesResponse(self): + """Test GetEmployeeSchedulesResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = GetEmployeeSchedulesResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_get_employees_response.py b/src/test/test_get_employees_response.py new file mode 100644 index 0000000000..a0421908b2 --- /dev/null +++ b/src/test/test_get_employees_response.py @@ -0,0 +1,41 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.employee import Employee +from apideck.model.links import Links +from apideck.model.meta import Meta +globals()['Employee'] = Employee +globals()['Links'] = Links +globals()['Meta'] = Meta +from apideck.model.get_employees_response import GetEmployeesResponse + + +class TestGetEmployeesResponse(unittest.TestCase): + """GetEmployeesResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGetEmployeesResponse(self): + """Test GetEmployeesResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = GetEmployeesResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_get_file_response.py b/src/test/test_get_file_response.py new file mode 100644 index 0000000000..dafd38ceaa --- /dev/null +++ b/src/test/test_get_file_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_file import UnifiedFile +globals()['UnifiedFile'] = UnifiedFile +from apideck.model.get_file_response import GetFileResponse + + +class TestGetFileResponse(unittest.TestCase): + """GetFileResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGetFileResponse(self): + """Test GetFileResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = GetFileResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_get_files_response.py b/src/test/test_get_files_response.py new file mode 100644 index 0000000000..94240f503e --- /dev/null +++ b/src/test/test_get_files_response.py @@ -0,0 +1,41 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.links import Links +from apideck.model.meta import Meta +from apideck.model.unified_file import UnifiedFile +globals()['Links'] = Links +globals()['Meta'] = Meta +globals()['UnifiedFile'] = UnifiedFile +from apideck.model.get_files_response import GetFilesResponse + + +class TestGetFilesResponse(unittest.TestCase): + """GetFilesResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGetFilesResponse(self): + """Test GetFilesResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = GetFilesResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_get_folder_response.py b/src/test/test_get_folder_response.py new file mode 100644 index 0000000000..07594bd088 --- /dev/null +++ b/src/test/test_get_folder_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.folder import Folder +globals()['Folder'] = Folder +from apideck.model.get_folder_response import GetFolderResponse + + +class TestGetFolderResponse(unittest.TestCase): + """GetFolderResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGetFolderResponse(self): + """Test GetFolderResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = GetFolderResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_get_folders_response.py b/src/test/test_get_folders_response.py new file mode 100644 index 0000000000..4a3af413cc --- /dev/null +++ b/src/test/test_get_folders_response.py @@ -0,0 +1,41 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.folder import Folder +from apideck.model.links import Links +from apideck.model.meta import Meta +globals()['Folder'] = Folder +globals()['Links'] = Links +globals()['Meta'] = Meta +from apideck.model.get_folders_response import GetFoldersResponse + + +class TestGetFoldersResponse(unittest.TestCase): + """GetFoldersResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGetFoldersResponse(self): + """Test GetFoldersResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = GetFoldersResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_get_hris_companies_response.py b/src/test/test_get_hris_companies_response.py new file mode 100644 index 0000000000..5a0d07f2db --- /dev/null +++ b/src/test/test_get_hris_companies_response.py @@ -0,0 +1,41 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.hris_company import HrisCompany +from apideck.model.links import Links +from apideck.model.meta import Meta +globals()['HrisCompany'] = HrisCompany +globals()['Links'] = Links +globals()['Meta'] = Meta +from apideck.model.get_hris_companies_response import GetHrisCompaniesResponse + + +class TestGetHrisCompaniesResponse(unittest.TestCase): + """GetHrisCompaniesResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGetHrisCompaniesResponse(self): + """Test GetHrisCompaniesResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = GetHrisCompaniesResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_get_hris_company_response.py b/src/test/test_get_hris_company_response.py new file mode 100644 index 0000000000..21ae564e76 --- /dev/null +++ b/src/test/test_get_hris_company_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.hris_company import HrisCompany +globals()['HrisCompany'] = HrisCompany +from apideck.model.get_hris_company_response import GetHrisCompanyResponse + + +class TestGetHrisCompanyResponse(unittest.TestCase): + """GetHrisCompanyResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGetHrisCompanyResponse(self): + """Test GetHrisCompanyResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = GetHrisCompanyResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_get_hris_job_response.py b/src/test/test_get_hris_job_response.py new file mode 100644 index 0000000000..f5dcd5ff28 --- /dev/null +++ b/src/test/test_get_hris_job_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.hris_job import HrisJob +globals()['HrisJob'] = HrisJob +from apideck.model.get_hris_job_response import GetHrisJobResponse + + +class TestGetHrisJobResponse(unittest.TestCase): + """GetHrisJobResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGetHrisJobResponse(self): + """Test GetHrisJobResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = GetHrisJobResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_get_hris_jobs_response.py b/src/test/test_get_hris_jobs_response.py new file mode 100644 index 0000000000..c1f96f8c48 --- /dev/null +++ b/src/test/test_get_hris_jobs_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.hris_jobs import HrisJobs +globals()['HrisJobs'] = HrisJobs +from apideck.model.get_hris_jobs_response import GetHrisJobsResponse + + +class TestGetHrisJobsResponse(unittest.TestCase): + """GetHrisJobsResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGetHrisJobsResponse(self): + """Test GetHrisJobsResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = GetHrisJobsResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_get_invoice_item_response.py b/src/test/test_get_invoice_item_response.py new file mode 100644 index 0000000000..d7682cb6fe --- /dev/null +++ b/src/test/test_get_invoice_item_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.invoice_item import InvoiceItem +globals()['InvoiceItem'] = InvoiceItem +from apideck.model.get_invoice_item_response import GetInvoiceItemResponse + + +class TestGetInvoiceItemResponse(unittest.TestCase): + """GetInvoiceItemResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGetInvoiceItemResponse(self): + """Test GetInvoiceItemResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = GetInvoiceItemResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_get_invoice_items_response.py b/src/test/test_get_invoice_items_response.py new file mode 100644 index 0000000000..36640c1475 --- /dev/null +++ b/src/test/test_get_invoice_items_response.py @@ -0,0 +1,41 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.invoice_item import InvoiceItem +from apideck.model.links import Links +from apideck.model.meta import Meta +globals()['InvoiceItem'] = InvoiceItem +globals()['Links'] = Links +globals()['Meta'] = Meta +from apideck.model.get_invoice_items_response import GetInvoiceItemsResponse + + +class TestGetInvoiceItemsResponse(unittest.TestCase): + """GetInvoiceItemsResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGetInvoiceItemsResponse(self): + """Test GetInvoiceItemsResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = GetInvoiceItemsResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_get_invoice_response.py b/src/test/test_get_invoice_response.py new file mode 100644 index 0000000000..6c0c0dd441 --- /dev/null +++ b/src/test/test_get_invoice_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.invoice import Invoice +globals()['Invoice'] = Invoice +from apideck.model.get_invoice_response import GetInvoiceResponse + + +class TestGetInvoiceResponse(unittest.TestCase): + """GetInvoiceResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGetInvoiceResponse(self): + """Test GetInvoiceResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = GetInvoiceResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_get_invoices_response.py b/src/test/test_get_invoices_response.py new file mode 100644 index 0000000000..2b8c0c760d --- /dev/null +++ b/src/test/test_get_invoices_response.py @@ -0,0 +1,41 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.invoice import Invoice +from apideck.model.links import Links +from apideck.model.meta import Meta +globals()['Invoice'] = Invoice +globals()['Links'] = Links +globals()['Meta'] = Meta +from apideck.model.get_invoices_response import GetInvoicesResponse + + +class TestGetInvoicesResponse(unittest.TestCase): + """GetInvoicesResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGetInvoicesResponse(self): + """Test GetInvoicesResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = GetInvoicesResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_get_item_response.py b/src/test/test_get_item_response.py new file mode 100644 index 0000000000..96418c608b --- /dev/null +++ b/src/test/test_get_item_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.item import Item +globals()['Item'] = Item +from apideck.model.get_item_response import GetItemResponse + + +class TestGetItemResponse(unittest.TestCase): + """GetItemResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGetItemResponse(self): + """Test GetItemResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = GetItemResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_get_items_response.py b/src/test/test_get_items_response.py new file mode 100644 index 0000000000..1ceb0b1656 --- /dev/null +++ b/src/test/test_get_items_response.py @@ -0,0 +1,41 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.item import Item +from apideck.model.links import Links +from apideck.model.meta import Meta +globals()['Item'] = Item +globals()['Links'] = Links +globals()['Meta'] = Meta +from apideck.model.get_items_response import GetItemsResponse + + +class TestGetItemsResponse(unittest.TestCase): + """GetItemsResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGetItemsResponse(self): + """Test GetItemsResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = GetItemsResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_get_job_response.py b/src/test/test_get_job_response.py new file mode 100644 index 0000000000..053758ac85 --- /dev/null +++ b/src/test/test_get_job_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.job import Job +globals()['Job'] = Job +from apideck.model.get_job_response import GetJobResponse + + +class TestGetJobResponse(unittest.TestCase): + """GetJobResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGetJobResponse(self): + """Test GetJobResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = GetJobResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_get_jobs_response.py b/src/test/test_get_jobs_response.py new file mode 100644 index 0000000000..0b606c9ee7 --- /dev/null +++ b/src/test/test_get_jobs_response.py @@ -0,0 +1,41 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.job import Job +from apideck.model.links import Links +from apideck.model.meta import Meta +globals()['Job'] = Job +globals()['Links'] = Links +globals()['Meta'] = Meta +from apideck.model.get_jobs_response import GetJobsResponse + + +class TestGetJobsResponse(unittest.TestCase): + """GetJobsResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGetJobsResponse(self): + """Test GetJobsResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = GetJobsResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_get_lead_response.py b/src/test/test_get_lead_response.py new file mode 100644 index 0000000000..a9a0d584d2 --- /dev/null +++ b/src/test/test_get_lead_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.lead import Lead +globals()['Lead'] = Lead +from apideck.model.get_lead_response import GetLeadResponse + + +class TestGetLeadResponse(unittest.TestCase): + """GetLeadResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGetLeadResponse(self): + """Test GetLeadResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = GetLeadResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_get_leads_response.py b/src/test/test_get_leads_response.py new file mode 100644 index 0000000000..8f941f4a67 --- /dev/null +++ b/src/test/test_get_leads_response.py @@ -0,0 +1,41 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.lead import Lead +from apideck.model.links import Links +from apideck.model.meta import Meta +globals()['Lead'] = Lead +globals()['Links'] = Links +globals()['Meta'] = Meta +from apideck.model.get_leads_response import GetLeadsResponse + + +class TestGetLeadsResponse(unittest.TestCase): + """GetLeadsResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGetLeadsResponse(self): + """Test GetLeadsResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = GetLeadsResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_get_ledger_account_response.py b/src/test/test_get_ledger_account_response.py new file mode 100644 index 0000000000..213ca598c9 --- /dev/null +++ b/src/test/test_get_ledger_account_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.ledger_account import LedgerAccount +globals()['LedgerAccount'] = LedgerAccount +from apideck.model.get_ledger_account_response import GetLedgerAccountResponse + + +class TestGetLedgerAccountResponse(unittest.TestCase): + """GetLedgerAccountResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGetLedgerAccountResponse(self): + """Test GetLedgerAccountResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = GetLedgerAccountResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_get_ledger_accounts_response.py b/src/test/test_get_ledger_accounts_response.py new file mode 100644 index 0000000000..69f033acef --- /dev/null +++ b/src/test/test_get_ledger_accounts_response.py @@ -0,0 +1,41 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.ledger_account import LedgerAccount +from apideck.model.links import Links +from apideck.model.meta import Meta +globals()['LedgerAccount'] = LedgerAccount +globals()['Links'] = Links +globals()['Meta'] = Meta +from apideck.model.get_ledger_accounts_response import GetLedgerAccountsResponse + + +class TestGetLedgerAccountsResponse(unittest.TestCase): + """GetLedgerAccountsResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGetLedgerAccountsResponse(self): + """Test GetLedgerAccountsResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = GetLedgerAccountsResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_get_location_response.py b/src/test/test_get_location_response.py new file mode 100644 index 0000000000..bfaf798ee8 --- /dev/null +++ b/src/test/test_get_location_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.location import Location +globals()['Location'] = Location +from apideck.model.get_location_response import GetLocationResponse + + +class TestGetLocationResponse(unittest.TestCase): + """GetLocationResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGetLocationResponse(self): + """Test GetLocationResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = GetLocationResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_get_locations_response.py b/src/test/test_get_locations_response.py new file mode 100644 index 0000000000..50b013ac5f --- /dev/null +++ b/src/test/test_get_locations_response.py @@ -0,0 +1,41 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.links import Links +from apideck.model.location import Location +from apideck.model.meta import Meta +globals()['Links'] = Links +globals()['Location'] = Location +globals()['Meta'] = Meta +from apideck.model.get_locations_response import GetLocationsResponse + + +class TestGetLocationsResponse(unittest.TestCase): + """GetLocationsResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGetLocationsResponse(self): + """Test GetLocationsResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = GetLocationsResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_get_logs_response.py b/src/test/test_get_logs_response.py new file mode 100644 index 0000000000..daee6799ae --- /dev/null +++ b/src/test/test_get_logs_response.py @@ -0,0 +1,41 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.links import Links +from apideck.model.log import Log +from apideck.model.meta import Meta +globals()['Links'] = Links +globals()['Log'] = Log +globals()['Meta'] = Meta +from apideck.model.get_logs_response import GetLogsResponse + + +class TestGetLogsResponse(unittest.TestCase): + """GetLogsResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGetLogsResponse(self): + """Test GetLogsResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = GetLogsResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_get_merchant_response.py b/src/test/test_get_merchant_response.py new file mode 100644 index 0000000000..0785e84ce3 --- /dev/null +++ b/src/test/test_get_merchant_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.merchant import Merchant +globals()['Merchant'] = Merchant +from apideck.model.get_merchant_response import GetMerchantResponse + + +class TestGetMerchantResponse(unittest.TestCase): + """GetMerchantResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGetMerchantResponse(self): + """Test GetMerchantResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = GetMerchantResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_get_merchants_response.py b/src/test/test_get_merchants_response.py new file mode 100644 index 0000000000..97c787c2b8 --- /dev/null +++ b/src/test/test_get_merchants_response.py @@ -0,0 +1,41 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.links import Links +from apideck.model.merchant import Merchant +from apideck.model.meta import Meta +globals()['Links'] = Links +globals()['Merchant'] = Merchant +globals()['Meta'] = Meta +from apideck.model.get_merchants_response import GetMerchantsResponse + + +class TestGetMerchantsResponse(unittest.TestCase): + """GetMerchantsResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGetMerchantsResponse(self): + """Test GetMerchantsResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = GetMerchantsResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_get_message_response.py b/src/test/test_get_message_response.py new file mode 100644 index 0000000000..bcc4196477 --- /dev/null +++ b/src/test/test_get_message_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.message import Message +globals()['Message'] = Message +from apideck.model.get_message_response import GetMessageResponse + + +class TestGetMessageResponse(unittest.TestCase): + """GetMessageResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGetMessageResponse(self): + """Test GetMessageResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = GetMessageResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_get_messages_response.py b/src/test/test_get_messages_response.py new file mode 100644 index 0000000000..20aa074977 --- /dev/null +++ b/src/test/test_get_messages_response.py @@ -0,0 +1,41 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.links import Links +from apideck.model.message import Message +from apideck.model.meta import Meta +globals()['Links'] = Links +globals()['Message'] = Message +globals()['Meta'] = Meta +from apideck.model.get_messages_response import GetMessagesResponse + + +class TestGetMessagesResponse(unittest.TestCase): + """GetMessagesResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGetMessagesResponse(self): + """Test GetMessagesResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = GetMessagesResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_get_modifier_group_response.py b/src/test/test_get_modifier_group_response.py new file mode 100644 index 0000000000..28d901c764 --- /dev/null +++ b/src/test/test_get_modifier_group_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.modifier_group import ModifierGroup +globals()['ModifierGroup'] = ModifierGroup +from apideck.model.get_modifier_group_response import GetModifierGroupResponse + + +class TestGetModifierGroupResponse(unittest.TestCase): + """GetModifierGroupResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGetModifierGroupResponse(self): + """Test GetModifierGroupResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = GetModifierGroupResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_get_modifier_groups_response.py b/src/test/test_get_modifier_groups_response.py new file mode 100644 index 0000000000..a0f8bcfd9c --- /dev/null +++ b/src/test/test_get_modifier_groups_response.py @@ -0,0 +1,41 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.links import Links +from apideck.model.meta import Meta +from apideck.model.modifier_group import ModifierGroup +globals()['Links'] = Links +globals()['Meta'] = Meta +globals()['ModifierGroup'] = ModifierGroup +from apideck.model.get_modifier_groups_response import GetModifierGroupsResponse + + +class TestGetModifierGroupsResponse(unittest.TestCase): + """GetModifierGroupsResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGetModifierGroupsResponse(self): + """Test GetModifierGroupsResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = GetModifierGroupsResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_get_modifier_response.py b/src/test/test_get_modifier_response.py new file mode 100644 index 0000000000..95567a1307 --- /dev/null +++ b/src/test/test_get_modifier_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.modifier import Modifier +globals()['Modifier'] = Modifier +from apideck.model.get_modifier_response import GetModifierResponse + + +class TestGetModifierResponse(unittest.TestCase): + """GetModifierResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGetModifierResponse(self): + """Test GetModifierResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = GetModifierResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_get_modifiers_response.py b/src/test/test_get_modifiers_response.py new file mode 100644 index 0000000000..cef9139ee8 --- /dev/null +++ b/src/test/test_get_modifiers_response.py @@ -0,0 +1,41 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.links import Links +from apideck.model.meta import Meta +from apideck.model.modifier import Modifier +globals()['Links'] = Links +globals()['Meta'] = Meta +globals()['Modifier'] = Modifier +from apideck.model.get_modifiers_response import GetModifiersResponse + + +class TestGetModifiersResponse(unittest.TestCase): + """GetModifiersResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGetModifiersResponse(self): + """Test GetModifiersResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = GetModifiersResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_get_note_response.py b/src/test/test_get_note_response.py new file mode 100644 index 0000000000..2e487eb826 --- /dev/null +++ b/src/test/test_get_note_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.note import Note +globals()['Note'] = Note +from apideck.model.get_note_response import GetNoteResponse + + +class TestGetNoteResponse(unittest.TestCase): + """GetNoteResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGetNoteResponse(self): + """Test GetNoteResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = GetNoteResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_get_notes_response.py b/src/test/test_get_notes_response.py new file mode 100644 index 0000000000..551e187391 --- /dev/null +++ b/src/test/test_get_notes_response.py @@ -0,0 +1,41 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.links import Links +from apideck.model.meta import Meta +from apideck.model.note import Note +globals()['Links'] = Links +globals()['Meta'] = Meta +globals()['Note'] = Note +from apideck.model.get_notes_response import GetNotesResponse + + +class TestGetNotesResponse(unittest.TestCase): + """GetNotesResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGetNotesResponse(self): + """Test GetNotesResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = GetNotesResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_get_opportunities_response.py b/src/test/test_get_opportunities_response.py new file mode 100644 index 0000000000..61ee5963cb --- /dev/null +++ b/src/test/test_get_opportunities_response.py @@ -0,0 +1,41 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.links import Links +from apideck.model.meta import Meta +from apideck.model.opportunity import Opportunity +globals()['Links'] = Links +globals()['Meta'] = Meta +globals()['Opportunity'] = Opportunity +from apideck.model.get_opportunities_response import GetOpportunitiesResponse + + +class TestGetOpportunitiesResponse(unittest.TestCase): + """GetOpportunitiesResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGetOpportunitiesResponse(self): + """Test GetOpportunitiesResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = GetOpportunitiesResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_get_opportunity_response.py b/src/test/test_get_opportunity_response.py new file mode 100644 index 0000000000..e7bc881263 --- /dev/null +++ b/src/test/test_get_opportunity_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.opportunity import Opportunity +globals()['Opportunity'] = Opportunity +from apideck.model.get_opportunity_response import GetOpportunityResponse + + +class TestGetOpportunityResponse(unittest.TestCase): + """GetOpportunityResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGetOpportunityResponse(self): + """Test GetOpportunityResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = GetOpportunityResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_get_order_response.py b/src/test/test_get_order_response.py new file mode 100644 index 0000000000..e625f17142 --- /dev/null +++ b/src/test/test_get_order_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.order import Order +globals()['Order'] = Order +from apideck.model.get_order_response import GetOrderResponse + + +class TestGetOrderResponse(unittest.TestCase): + """GetOrderResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGetOrderResponse(self): + """Test GetOrderResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = GetOrderResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_get_order_type_response.py b/src/test/test_get_order_type_response.py new file mode 100644 index 0000000000..6a6d2cb65d --- /dev/null +++ b/src/test/test_get_order_type_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.order_type import OrderType +globals()['OrderType'] = OrderType +from apideck.model.get_order_type_response import GetOrderTypeResponse + + +class TestGetOrderTypeResponse(unittest.TestCase): + """GetOrderTypeResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGetOrderTypeResponse(self): + """Test GetOrderTypeResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = GetOrderTypeResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_get_order_types_response.py b/src/test/test_get_order_types_response.py new file mode 100644 index 0000000000..a5b4c6c74b --- /dev/null +++ b/src/test/test_get_order_types_response.py @@ -0,0 +1,41 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.links import Links +from apideck.model.meta import Meta +from apideck.model.order_type import OrderType +globals()['Links'] = Links +globals()['Meta'] = Meta +globals()['OrderType'] = OrderType +from apideck.model.get_order_types_response import GetOrderTypesResponse + + +class TestGetOrderTypesResponse(unittest.TestCase): + """GetOrderTypesResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGetOrderTypesResponse(self): + """Test GetOrderTypesResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = GetOrderTypesResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_get_orders_response.py b/src/test/test_get_orders_response.py new file mode 100644 index 0000000000..ee35e56d6a --- /dev/null +++ b/src/test/test_get_orders_response.py @@ -0,0 +1,41 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.links import Links +from apideck.model.meta import Meta +from apideck.model.order import Order +globals()['Links'] = Links +globals()['Meta'] = Meta +globals()['Order'] = Order +from apideck.model.get_orders_response import GetOrdersResponse + + +class TestGetOrdersResponse(unittest.TestCase): + """GetOrdersResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGetOrdersResponse(self): + """Test GetOrdersResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = GetOrdersResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_get_payment_response.py b/src/test/test_get_payment_response.py new file mode 100644 index 0000000000..f9d062b867 --- /dev/null +++ b/src/test/test_get_payment_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.payment import Payment +globals()['Payment'] = Payment +from apideck.model.get_payment_response import GetPaymentResponse + + +class TestGetPaymentResponse(unittest.TestCase): + """GetPaymentResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGetPaymentResponse(self): + """Test GetPaymentResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = GetPaymentResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_get_payments_response.py b/src/test/test_get_payments_response.py new file mode 100644 index 0000000000..5572182efc --- /dev/null +++ b/src/test/test_get_payments_response.py @@ -0,0 +1,41 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.links import Links +from apideck.model.meta import Meta +from apideck.model.payment import Payment +globals()['Links'] = Links +globals()['Meta'] = Meta +globals()['Payment'] = Payment +from apideck.model.get_payments_response import GetPaymentsResponse + + +class TestGetPaymentsResponse(unittest.TestCase): + """GetPaymentsResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGetPaymentsResponse(self): + """Test GetPaymentsResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = GetPaymentsResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_get_payroll_response.py b/src/test/test_get_payroll_response.py new file mode 100644 index 0000000000..ec6686cc16 --- /dev/null +++ b/src/test/test_get_payroll_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.payroll import Payroll +globals()['Payroll'] = Payroll +from apideck.model.get_payroll_response import GetPayrollResponse + + +class TestGetPayrollResponse(unittest.TestCase): + """GetPayrollResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGetPayrollResponse(self): + """Test GetPayrollResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = GetPayrollResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_get_payrolls_response.py b/src/test/test_get_payrolls_response.py new file mode 100644 index 0000000000..7eccba22f2 --- /dev/null +++ b/src/test/test_get_payrolls_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.payroll import Payroll +globals()['Payroll'] = Payroll +from apideck.model.get_payrolls_response import GetPayrollsResponse + + +class TestGetPayrollsResponse(unittest.TestCase): + """GetPayrollsResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGetPayrollsResponse(self): + """Test GetPayrollsResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = GetPayrollsResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_get_pipeline_response.py b/src/test/test_get_pipeline_response.py new file mode 100644 index 0000000000..5fe589bb6a --- /dev/null +++ b/src/test/test_get_pipeline_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.pipeline import Pipeline +globals()['Pipeline'] = Pipeline +from apideck.model.get_pipeline_response import GetPipelineResponse + + +class TestGetPipelineResponse(unittest.TestCase): + """GetPipelineResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGetPipelineResponse(self): + """Test GetPipelineResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = GetPipelineResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_get_pipelines_response.py b/src/test/test_get_pipelines_response.py new file mode 100644 index 0000000000..1fb4815b44 --- /dev/null +++ b/src/test/test_get_pipelines_response.py @@ -0,0 +1,41 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.links import Links +from apideck.model.meta import Meta +from apideck.model.pipeline import Pipeline +globals()['Links'] = Links +globals()['Meta'] = Meta +globals()['Pipeline'] = Pipeline +from apideck.model.get_pipelines_response import GetPipelinesResponse + + +class TestGetPipelinesResponse(unittest.TestCase): + """GetPipelinesResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGetPipelinesResponse(self): + """Test GetPipelinesResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = GetPipelinesResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_get_pos_payment_response.py b/src/test/test_get_pos_payment_response.py new file mode 100644 index 0000000000..98d2c63b05 --- /dev/null +++ b/src/test/test_get_pos_payment_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.pos_payment import PosPayment +globals()['PosPayment'] = PosPayment +from apideck.model.get_pos_payment_response import GetPosPaymentResponse + + +class TestGetPosPaymentResponse(unittest.TestCase): + """GetPosPaymentResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGetPosPaymentResponse(self): + """Test GetPosPaymentResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = GetPosPaymentResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_get_pos_payments_response.py b/src/test/test_get_pos_payments_response.py new file mode 100644 index 0000000000..fd7a1c27d0 --- /dev/null +++ b/src/test/test_get_pos_payments_response.py @@ -0,0 +1,41 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.links import Links +from apideck.model.meta import Meta +from apideck.model.pos_payment import PosPayment +globals()['Links'] = Links +globals()['Meta'] = Meta +globals()['PosPayment'] = PosPayment +from apideck.model.get_pos_payments_response import GetPosPaymentsResponse + + +class TestGetPosPaymentsResponse(unittest.TestCase): + """GetPosPaymentsResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGetPosPaymentsResponse(self): + """Test GetPosPaymentsResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = GetPosPaymentsResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_get_profit_and_loss_response.py b/src/test/test_get_profit_and_loss_response.py new file mode 100644 index 0000000000..3954bedf08 --- /dev/null +++ b/src/test/test_get_profit_and_loss_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.profit_and_loss import ProfitAndLoss +globals()['ProfitAndLoss'] = ProfitAndLoss +from apideck.model.get_profit_and_loss_response import GetProfitAndLossResponse + + +class TestGetProfitAndLossResponse(unittest.TestCase): + """GetProfitAndLossResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGetProfitAndLossResponse(self): + """Test GetProfitAndLossResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = GetProfitAndLossResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_get_shared_link_response.py b/src/test/test_get_shared_link_response.py new file mode 100644 index 0000000000..1250bce93e --- /dev/null +++ b/src/test/test_get_shared_link_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.shared_link import SharedLink +globals()['SharedLink'] = SharedLink +from apideck.model.get_shared_link_response import GetSharedLinkResponse + + +class TestGetSharedLinkResponse(unittest.TestCase): + """GetSharedLinkResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGetSharedLinkResponse(self): + """Test GetSharedLinkResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = GetSharedLinkResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_get_shared_links_response.py b/src/test/test_get_shared_links_response.py new file mode 100644 index 0000000000..c0d2f14469 --- /dev/null +++ b/src/test/test_get_shared_links_response.py @@ -0,0 +1,41 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.links import Links +from apideck.model.meta import Meta +from apideck.model.shared_link import SharedLink +globals()['Links'] = Links +globals()['Meta'] = Meta +globals()['SharedLink'] = SharedLink +from apideck.model.get_shared_links_response import GetSharedLinksResponse + + +class TestGetSharedLinksResponse(unittest.TestCase): + """GetSharedLinksResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGetSharedLinksResponse(self): + """Test GetSharedLinksResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = GetSharedLinksResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_get_supplier_response.py b/src/test/test_get_supplier_response.py new file mode 100644 index 0000000000..0d2ac49b49 --- /dev/null +++ b/src/test/test_get_supplier_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.supplier import Supplier +globals()['Supplier'] = Supplier +from apideck.model.get_supplier_response import GetSupplierResponse + + +class TestGetSupplierResponse(unittest.TestCase): + """GetSupplierResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGetSupplierResponse(self): + """Test GetSupplierResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = GetSupplierResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_get_suppliers_response.py b/src/test/test_get_suppliers_response.py new file mode 100644 index 0000000000..451b353e39 --- /dev/null +++ b/src/test/test_get_suppliers_response.py @@ -0,0 +1,41 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.links import Links +from apideck.model.meta import Meta +from apideck.model.supplier import Supplier +globals()['Links'] = Links +globals()['Meta'] = Meta +globals()['Supplier'] = Supplier +from apideck.model.get_suppliers_response import GetSuppliersResponse + + +class TestGetSuppliersResponse(unittest.TestCase): + """GetSuppliersResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGetSuppliersResponse(self): + """Test GetSuppliersResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = GetSuppliersResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_get_tax_rate_response.py b/src/test/test_get_tax_rate_response.py new file mode 100644 index 0000000000..908c54c580 --- /dev/null +++ b/src/test/test_get_tax_rate_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.tax_rate import TaxRate +globals()['TaxRate'] = TaxRate +from apideck.model.get_tax_rate_response import GetTaxRateResponse + + +class TestGetTaxRateResponse(unittest.TestCase): + """GetTaxRateResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGetTaxRateResponse(self): + """Test GetTaxRateResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = GetTaxRateResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_get_tax_rates_response.py b/src/test/test_get_tax_rates_response.py new file mode 100644 index 0000000000..2229d45845 --- /dev/null +++ b/src/test/test_get_tax_rates_response.py @@ -0,0 +1,41 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.links import Links +from apideck.model.meta import Meta +from apideck.model.tax_rate import TaxRate +globals()['Links'] = Links +globals()['Meta'] = Meta +globals()['TaxRate'] = TaxRate +from apideck.model.get_tax_rates_response import GetTaxRatesResponse + + +class TestGetTaxRatesResponse(unittest.TestCase): + """GetTaxRatesResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGetTaxRatesResponse(self): + """Test GetTaxRatesResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = GetTaxRatesResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_get_tender_response.py b/src/test/test_get_tender_response.py new file mode 100644 index 0000000000..5c1398c85d --- /dev/null +++ b/src/test/test_get_tender_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.tender import Tender +globals()['Tender'] = Tender +from apideck.model.get_tender_response import GetTenderResponse + + +class TestGetTenderResponse(unittest.TestCase): + """GetTenderResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGetTenderResponse(self): + """Test GetTenderResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = GetTenderResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_get_tenders_response.py b/src/test/test_get_tenders_response.py new file mode 100644 index 0000000000..f3c527cb4c --- /dev/null +++ b/src/test/test_get_tenders_response.py @@ -0,0 +1,41 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.links import Links +from apideck.model.meta import Meta +from apideck.model.tender import Tender +globals()['Links'] = Links +globals()['Meta'] = Meta +globals()['Tender'] = Tender +from apideck.model.get_tenders_response import GetTendersResponse + + +class TestGetTendersResponse(unittest.TestCase): + """GetTendersResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGetTendersResponse(self): + """Test GetTendersResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = GetTendersResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_get_time_off_request_response.py b/src/test/test_get_time_off_request_response.py new file mode 100644 index 0000000000..6f4c91c1f3 --- /dev/null +++ b/src/test/test_get_time_off_request_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.time_off_request import TimeOffRequest +globals()['TimeOffRequest'] = TimeOffRequest +from apideck.model.get_time_off_request_response import GetTimeOffRequestResponse + + +class TestGetTimeOffRequestResponse(unittest.TestCase): + """GetTimeOffRequestResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGetTimeOffRequestResponse(self): + """Test GetTimeOffRequestResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = GetTimeOffRequestResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_get_time_off_requests_response.py b/src/test/test_get_time_off_requests_response.py new file mode 100644 index 0000000000..bd28903a8b --- /dev/null +++ b/src/test/test_get_time_off_requests_response.py @@ -0,0 +1,41 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.links import Links +from apideck.model.meta import Meta +from apideck.model.time_off_request import TimeOffRequest +globals()['Links'] = Links +globals()['Meta'] = Meta +globals()['TimeOffRequest'] = TimeOffRequest +from apideck.model.get_time_off_requests_response import GetTimeOffRequestsResponse + + +class TestGetTimeOffRequestsResponse(unittest.TestCase): + """GetTimeOffRequestsResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGetTimeOffRequestsResponse(self): + """Test GetTimeOffRequestsResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = GetTimeOffRequestsResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_get_upload_session_response.py b/src/test/test_get_upload_session_response.py new file mode 100644 index 0000000000..26d4506b01 --- /dev/null +++ b/src/test/test_get_upload_session_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.upload_session import UploadSession +globals()['UploadSession'] = UploadSession +from apideck.model.get_upload_session_response import GetUploadSessionResponse + + +class TestGetUploadSessionResponse(unittest.TestCase): + """GetUploadSessionResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGetUploadSessionResponse(self): + """Test GetUploadSessionResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = GetUploadSessionResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_get_user_response.py b/src/test/test_get_user_response.py new file mode 100644 index 0000000000..69d56edd01 --- /dev/null +++ b/src/test/test_get_user_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.user import User +globals()['User'] = User +from apideck.model.get_user_response import GetUserResponse + + +class TestGetUserResponse(unittest.TestCase): + """GetUserResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGetUserResponse(self): + """Test GetUserResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = GetUserResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_get_users_response.py b/src/test/test_get_users_response.py new file mode 100644 index 0000000000..373cd03408 --- /dev/null +++ b/src/test/test_get_users_response.py @@ -0,0 +1,41 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.links import Links +from apideck.model.meta import Meta +from apideck.model.user import User +globals()['Links'] = Links +globals()['Meta'] = Meta +globals()['User'] = User +from apideck.model.get_users_response import GetUsersResponse + + +class TestGetUsersResponse(unittest.TestCase): + """GetUsersResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGetUsersResponse(self): + """Test GetUsersResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = GetUsersResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_get_webhook_event_logs_response.py b/src/test/test_get_webhook_event_logs_response.py new file mode 100644 index 0000000000..698e5dc661 --- /dev/null +++ b/src/test/test_get_webhook_event_logs_response.py @@ -0,0 +1,41 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.links import Links +from apideck.model.meta import Meta +from apideck.model.webhook_event_log import WebhookEventLog +globals()['Links'] = Links +globals()['Meta'] = Meta +globals()['WebhookEventLog'] = WebhookEventLog +from apideck.model.get_webhook_event_logs_response import GetWebhookEventLogsResponse + + +class TestGetWebhookEventLogsResponse(unittest.TestCase): + """GetWebhookEventLogsResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGetWebhookEventLogsResponse(self): + """Test GetWebhookEventLogsResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = GetWebhookEventLogsResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_get_webhook_response.py b/src/test/test_get_webhook_response.py new file mode 100644 index 0000000000..7e366017bf --- /dev/null +++ b/src/test/test_get_webhook_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.webhook import Webhook +globals()['Webhook'] = Webhook +from apideck.model.get_webhook_response import GetWebhookResponse + + +class TestGetWebhookResponse(unittest.TestCase): + """GetWebhookResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGetWebhookResponse(self): + """Test GetWebhookResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = GetWebhookResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_get_webhooks_response.py b/src/test/test_get_webhooks_response.py new file mode 100644 index 0000000000..3bbb949550 --- /dev/null +++ b/src/test/test_get_webhooks_response.py @@ -0,0 +1,41 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.links import Links +from apideck.model.meta import Meta +from apideck.model.webhook import Webhook +globals()['Links'] = Links +globals()['Meta'] = Meta +globals()['Webhook'] = Webhook +from apideck.model.get_webhooks_response import GetWebhooksResponse + + +class TestGetWebhooksResponse(unittest.TestCase): + """GetWebhooksResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testGetWebhooksResponse(self): + """Test GetWebhooksResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = GetWebhooksResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_hris_api.py b/src/test/test_hris_api.py new file mode 100644 index 0000000000..05860a554f --- /dev/null +++ b/src/test/test_hris_api.py @@ -0,0 +1,217 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import apideck +from apideck.api.hris_api import HrisApi # noqa: E501 + + +class TestHrisApi(unittest.TestCase): + """HrisApi unit test stubs""" + + def setUp(self): + self.api = HrisApi() # noqa: E501 + + def tearDown(self): + pass + + def test_companies_add(self): + """Test case for companies_add + + Create Company # noqa: E501 + """ + pass + + def test_companies_all(self): + """Test case for companies_all + + List Companies # noqa: E501 + """ + pass + + def test_companies_delete(self): + """Test case for companies_delete + + Delete Company # noqa: E501 + """ + pass + + def test_companies_one(self): + """Test case for companies_one + + Get Company # noqa: E501 + """ + pass + + def test_companies_update(self): + """Test case for companies_update + + Update Company # noqa: E501 + """ + pass + + def test_departments_add(self): + """Test case for departments_add + + Create Department # noqa: E501 + """ + pass + + def test_departments_all(self): + """Test case for departments_all + + List Departments # noqa: E501 + """ + pass + + def test_departments_delete(self): + """Test case for departments_delete + + Delete Department # noqa: E501 + """ + pass + + def test_departments_one(self): + """Test case for departments_one + + Get Department # noqa: E501 + """ + pass + + def test_departments_update(self): + """Test case for departments_update + + Update Department # noqa: E501 + """ + pass + + def test_employee_payrolls_all(self): + """Test case for employee_payrolls_all + + List Employee Payrolls # noqa: E501 + """ + pass + + def test_employee_payrolls_one(self): + """Test case for employee_payrolls_one + + Get Employee Payroll # noqa: E501 + """ + pass + + def test_employee_schedules_all(self): + """Test case for employee_schedules_all + + List Employee Schedules # noqa: E501 + """ + pass + + def test_employees_add(self): + """Test case for employees_add + + Create Employee # noqa: E501 + """ + pass + + def test_employees_all(self): + """Test case for employees_all + + List Employees # noqa: E501 + """ + pass + + def test_employees_delete(self): + """Test case for employees_delete + + Delete Employee # noqa: E501 + """ + pass + + def test_employees_one(self): + """Test case for employees_one + + Get Employee # noqa: E501 + """ + pass + + def test_employees_update(self): + """Test case for employees_update + + Update Employee # noqa: E501 + """ + pass + + def test_jobs_all(self): + """Test case for jobs_all + + List Jobs # noqa: E501 + """ + pass + + def test_jobs_one(self): + """Test case for jobs_one + + One Job # noqa: E501 + """ + pass + + def test_payrolls_all(self): + """Test case for payrolls_all + + List Payroll # noqa: E501 + """ + pass + + def test_payrolls_one(self): + """Test case for payrolls_one + + Get Payroll # noqa: E501 + """ + pass + + def test_time_off_requests_add(self): + """Test case for time_off_requests_add + + Create Time Off Request # noqa: E501 + """ + pass + + def test_time_off_requests_all(self): + """Test case for time_off_requests_all + + List Time Off Requests # noqa: E501 + """ + pass + + def test_time_off_requests_delete(self): + """Test case for time_off_requests_delete + + Delete Time Off Request # noqa: E501 + """ + pass + + def test_time_off_requests_one(self): + """Test case for time_off_requests_one + + Get Time Off Request # noqa: E501 + """ + pass + + def test_time_off_requests_update(self): + """Test case for time_off_requests_update + + Update Time Off Request # noqa: E501 + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_hris_company.py b/src/test/test_hris_company.py new file mode 100644 index 0000000000..053e08c253 --- /dev/null +++ b/src/test/test_hris_company.py @@ -0,0 +1,43 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.address import Address +from apideck.model.email import Email +from apideck.model.phone_number import PhoneNumber +from apideck.model.website import Website +globals()['Address'] = Address +globals()['Email'] = Email +globals()['PhoneNumber'] = PhoneNumber +globals()['Website'] = Website +from apideck.model.hris_company import HrisCompany + + +class TestHrisCompany(unittest.TestCase): + """HrisCompany unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testHrisCompany(self): + """Test HrisCompany""" + # FIXME: construct object with mandatory attributes with example values + # model = HrisCompany() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_hris_event_type.py b/src/test/test_hris_event_type.py new file mode 100644 index 0000000000..1ff8d24f72 --- /dev/null +++ b/src/test/test_hris_event_type.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.hris_event_type import HrisEventType + + +class TestHrisEventType(unittest.TestCase): + """HrisEventType unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testHrisEventType(self): + """Test HrisEventType""" + # FIXME: construct object with mandatory attributes with example values + # model = HrisEventType() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_hris_job.py b/src/test/test_hris_job.py new file mode 100644 index 0000000000..9d224fb41f --- /dev/null +++ b/src/test/test_hris_job.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.hris_job_location import HrisJobLocation +globals()['HrisJobLocation'] = HrisJobLocation +from apideck.model.hris_job import HrisJob + + +class TestHrisJob(unittest.TestCase): + """HrisJob unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testHrisJob(self): + """Test HrisJob""" + # FIXME: construct object with mandatory attributes with example values + # model = HrisJob() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_hris_job_location.py b/src/test/test_hris_job_location.py new file mode 100644 index 0000000000..1f02e2ec7c --- /dev/null +++ b/src/test/test_hris_job_location.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.hris_job_location import HrisJobLocation + + +class TestHrisJobLocation(unittest.TestCase): + """HrisJobLocation unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testHrisJobLocation(self): + """Test HrisJobLocation""" + # FIXME: construct object with mandatory attributes with example values + # model = HrisJobLocation() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_hris_jobs.py b/src/test/test_hris_jobs.py new file mode 100644 index 0000000000..9c96f60d60 --- /dev/null +++ b/src/test/test_hris_jobs.py @@ -0,0 +1,39 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.employee import Employee +from apideck.model.hris_job import HrisJob +globals()['Employee'] = Employee +globals()['HrisJob'] = HrisJob +from apideck.model.hris_jobs import HrisJobs + + +class TestHrisJobs(unittest.TestCase): + """HrisJobs unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testHrisJobs(self): + """Test HrisJobs""" + # FIXME: construct object with mandatory attributes with example values + # model = HrisJobs() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_idempotency_key.py b/src/test/test_idempotency_key.py new file mode 100644 index 0000000000..cc77dfef52 --- /dev/null +++ b/src/test/test_idempotency_key.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.idempotency_key import IdempotencyKey + + +class TestIdempotencyKey(unittest.TestCase): + """IdempotencyKey unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testIdempotencyKey(self): + """Test IdempotencyKey""" + # FIXME: construct object with mandatory attributes with example values + # model = IdempotencyKey() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_invoice.py b/src/test/test_invoice.py new file mode 100644 index 0000000000..d56067e32c --- /dev/null +++ b/src/test/test_invoice.py @@ -0,0 +1,43 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.address import Address +from apideck.model.currency import Currency +from apideck.model.invoice_line_item import InvoiceLineItem +from apideck.model.linked_customer import LinkedCustomer +globals()['Address'] = Address +globals()['Currency'] = Currency +globals()['InvoiceLineItem'] = InvoiceLineItem +globals()['LinkedCustomer'] = LinkedCustomer +from apideck.model.invoice import Invoice + + +class TestInvoice(unittest.TestCase): + """Invoice unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInvoice(self): + """Test Invoice""" + # FIXME: construct object with mandatory attributes with example values + # model = Invoice() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_invoice_item.py b/src/test/test_invoice_item.py new file mode 100644 index 0000000000..dba2a47400 --- /dev/null +++ b/src/test/test_invoice_item.py @@ -0,0 +1,39 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.invoice_item_sales_details import InvoiceItemSalesDetails +from apideck.model.linked_ledger_account import LinkedLedgerAccount +globals()['InvoiceItemSalesDetails'] = InvoiceItemSalesDetails +globals()['LinkedLedgerAccount'] = LinkedLedgerAccount +from apideck.model.invoice_item import InvoiceItem + + +class TestInvoiceItem(unittest.TestCase): + """InvoiceItem unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInvoiceItem(self): + """Test InvoiceItem""" + # FIXME: construct object with mandatory attributes with example values + # model = InvoiceItem() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_invoice_item_asset_account.py b/src/test/test_invoice_item_asset_account.py new file mode 100644 index 0000000000..9306904f53 --- /dev/null +++ b/src/test/test_invoice_item_asset_account.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.invoice_item_asset_account import InvoiceItemAssetAccount + + +class TestInvoiceItemAssetAccount(unittest.TestCase): + """InvoiceItemAssetAccount unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInvoiceItemAssetAccount(self): + """Test InvoiceItemAssetAccount""" + # FIXME: construct object with mandatory attributes with example values + # model = InvoiceItemAssetAccount() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_invoice_item_expense_account.py b/src/test/test_invoice_item_expense_account.py new file mode 100644 index 0000000000..9e3ec50930 --- /dev/null +++ b/src/test/test_invoice_item_expense_account.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.invoice_item_expense_account import InvoiceItemExpenseAccount + + +class TestInvoiceItemExpenseAccount(unittest.TestCase): + """InvoiceItemExpenseAccount unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInvoiceItemExpenseAccount(self): + """Test InvoiceItemExpenseAccount""" + # FIXME: construct object with mandatory attributes with example values + # model = InvoiceItemExpenseAccount() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_invoice_item_income_account.py b/src/test/test_invoice_item_income_account.py new file mode 100644 index 0000000000..7267866463 --- /dev/null +++ b/src/test/test_invoice_item_income_account.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.invoice_item_income_account import InvoiceItemIncomeAccount + + +class TestInvoiceItemIncomeAccount(unittest.TestCase): + """InvoiceItemIncomeAccount unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInvoiceItemIncomeAccount(self): + """Test InvoiceItemIncomeAccount""" + # FIXME: construct object with mandatory attributes with example values + # model = InvoiceItemIncomeAccount() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_invoice_item_sales_details.py b/src/test/test_invoice_item_sales_details.py new file mode 100644 index 0000000000..3cc46b45d4 --- /dev/null +++ b/src/test/test_invoice_item_sales_details.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.linked_tax_rate import LinkedTaxRate +globals()['LinkedTaxRate'] = LinkedTaxRate +from apideck.model.invoice_item_sales_details import InvoiceItemSalesDetails + + +class TestInvoiceItemSalesDetails(unittest.TestCase): + """InvoiceItemSalesDetails unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInvoiceItemSalesDetails(self): + """Test InvoiceItemSalesDetails""" + # FIXME: construct object with mandatory attributes with example values + # model = InvoiceItemSalesDetails() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_invoice_items_filter.py b/src/test/test_invoice_items_filter.py new file mode 100644 index 0000000000..4e9f6dbd28 --- /dev/null +++ b/src/test/test_invoice_items_filter.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.invoice_items_filter import InvoiceItemsFilter + + +class TestInvoiceItemsFilter(unittest.TestCase): + """InvoiceItemsFilter unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInvoiceItemsFilter(self): + """Test InvoiceItemsFilter""" + # FIXME: construct object with mandatory attributes with example values + # model = InvoiceItemsFilter() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_invoice_line_item.py b/src/test/test_invoice_line_item.py new file mode 100644 index 0000000000..7d366ff1dc --- /dev/null +++ b/src/test/test_invoice_line_item.py @@ -0,0 +1,41 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.linked_invoice_item import LinkedInvoiceItem +from apideck.model.linked_ledger_account import LinkedLedgerAccount +from apideck.model.linked_tax_rate import LinkedTaxRate +globals()['LinkedInvoiceItem'] = LinkedInvoiceItem +globals()['LinkedLedgerAccount'] = LinkedLedgerAccount +globals()['LinkedTaxRate'] = LinkedTaxRate +from apideck.model.invoice_line_item import InvoiceLineItem + + +class TestInvoiceLineItem(unittest.TestCase): + """InvoiceLineItem unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInvoiceLineItem(self): + """Test InvoiceLineItem""" + # FIXME: construct object with mandatory attributes with example values + # model = InvoiceLineItem() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_invoice_response.py b/src/test/test_invoice_response.py new file mode 100644 index 0000000000..5ddfd2fa22 --- /dev/null +++ b/src/test/test_invoice_response.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.invoice_response import InvoiceResponse + + +class TestInvoiceResponse(unittest.TestCase): + """InvoiceResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInvoiceResponse(self): + """Test InvoiceResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = InvoiceResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_invoices_sort.py b/src/test/test_invoices_sort.py new file mode 100644 index 0000000000..7c15aa3310 --- /dev/null +++ b/src/test/test_invoices_sort.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.sort_direction import SortDirection +globals()['SortDirection'] = SortDirection +from apideck.model.invoices_sort import InvoicesSort + + +class TestInvoicesSort(unittest.TestCase): + """InvoicesSort unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInvoicesSort(self): + """Test InvoicesSort""" + # FIXME: construct object with mandatory attributes with example values + # model = InvoicesSort() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_item.py b/src/test/test_item.py new file mode 100644 index 0000000000..88156d0b01 --- /dev/null +++ b/src/test/test_item.py @@ -0,0 +1,39 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.currency import Currency +from apideck.model.idempotency_key import IdempotencyKey +globals()['Currency'] = Currency +globals()['IdempotencyKey'] = IdempotencyKey +from apideck.model.item import Item + + +class TestItem(unittest.TestCase): + """Item unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testItem(self): + """Test Item""" + # FIXME: construct object with mandatory attributes with example values + # model = Item() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_job.py b/src/test/test_job.py new file mode 100644 index 0000000000..88dca32707 --- /dev/null +++ b/src/test/test_job.py @@ -0,0 +1,47 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.address import Address +from apideck.model.branch import Branch +from apideck.model.department import Department +from apideck.model.job_salary import JobSalary +from apideck.model.job_status import JobStatus +from apideck.model.tags import Tags +globals()['Address'] = Address +globals()['Branch'] = Branch +globals()['Department'] = Department +globals()['JobSalary'] = JobSalary +globals()['JobStatus'] = JobStatus +globals()['Tags'] = Tags +from apideck.model.job import Job + + +class TestJob(unittest.TestCase): + """Job unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testJob(self): + """Test Job""" + # FIXME: construct object with mandatory attributes with example values + # model = Job() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_job_salary.py b/src/test/test_job_salary.py new file mode 100644 index 0000000000..1b22295fef --- /dev/null +++ b/src/test/test_job_salary.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.currency import Currency +globals()['Currency'] = Currency +from apideck.model.job_salary import JobSalary + + +class TestJobSalary(unittest.TestCase): + """JobSalary unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testJobSalary(self): + """Test JobSalary""" + # FIXME: construct object with mandatory attributes with example values + # model = JobSalary() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_job_status.py b/src/test/test_job_status.py new file mode 100644 index 0000000000..0611d5ec0d --- /dev/null +++ b/src/test/test_job_status.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.job_status import JobStatus + + +class TestJobStatus(unittest.TestCase): + """JobStatus unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testJobStatus(self): + """Test JobStatus""" + # FIXME: construct object with mandatory attributes with example values + # model = JobStatus() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_jobs_filter.py b/src/test/test_jobs_filter.py new file mode 100644 index 0000000000..f4cd49a869 --- /dev/null +++ b/src/test/test_jobs_filter.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.jobs_filter import JobsFilter + + +class TestJobsFilter(unittest.TestCase): + """JobsFilter unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testJobsFilter(self): + """Test JobsFilter""" + # FIXME: construct object with mandatory attributes with example values + # model = JobsFilter() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_lead.py b/src/test/test_lead.py new file mode 100644 index 0000000000..3a2509f697 --- /dev/null +++ b/src/test/test_lead.py @@ -0,0 +1,51 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.address import Address +from apideck.model.currency import Currency +from apideck.model.custom_field import CustomField +from apideck.model.email import Email +from apideck.model.phone_number import PhoneNumber +from apideck.model.social_link import SocialLink +from apideck.model.tags import Tags +from apideck.model.website import Website +globals()['Address'] = Address +globals()['Currency'] = Currency +globals()['CustomField'] = CustomField +globals()['Email'] = Email +globals()['PhoneNumber'] = PhoneNumber +globals()['SocialLink'] = SocialLink +globals()['Tags'] = Tags +globals()['Website'] = Website +from apideck.model.lead import Lead + + +class TestLead(unittest.TestCase): + """Lead unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testLead(self): + """Test Lead""" + # FIXME: construct object with mandatory attributes with example values + # model = Lead() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_lead_api.py b/src/test/test_lead_api.py new file mode 100644 index 0000000000..fe7a467928 --- /dev/null +++ b/src/test/test_lead_api.py @@ -0,0 +1,63 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import apideck +from apideck.api.lead_api import LeadApi # noqa: E501 + + +class TestLeadApi(unittest.TestCase): + """LeadApi unit test stubs""" + + def setUp(self): + self.api = LeadApi() # noqa: E501 + + def tearDown(self): + pass + + def test_leads_add(self): + """Test case for leads_add + + Create lead # noqa: E501 + """ + pass + + def test_leads_all(self): + """Test case for leads_all + + List leads # noqa: E501 + """ + pass + + def test_leads_delete(self): + """Test case for leads_delete + + Delete lead # noqa: E501 + """ + pass + + def test_leads_one(self): + """Test case for leads_one + + Get lead # noqa: E501 + """ + pass + + def test_leads_update(self): + """Test case for leads_update + + Update lead # noqa: E501 + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_lead_event_type.py b/src/test/test_lead_event_type.py new file mode 100644 index 0000000000..2bd3b66e8d --- /dev/null +++ b/src/test/test_lead_event_type.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.lead_event_type import LeadEventType + + +class TestLeadEventType(unittest.TestCase): + """LeadEventType unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testLeadEventType(self): + """Test LeadEventType""" + # FIXME: construct object with mandatory attributes with example values + # model = LeadEventType() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_leads_filter.py b/src/test/test_leads_filter.py new file mode 100644 index 0000000000..901a3dce19 --- /dev/null +++ b/src/test/test_leads_filter.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.leads_filter import LeadsFilter + + +class TestLeadsFilter(unittest.TestCase): + """LeadsFilter unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testLeadsFilter(self): + """Test LeadsFilter""" + # FIXME: construct object with mandatory attributes with example values + # model = LeadsFilter() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_leads_sort.py b/src/test/test_leads_sort.py new file mode 100644 index 0000000000..cdac5e86fc --- /dev/null +++ b/src/test/test_leads_sort.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.sort_direction import SortDirection +globals()['SortDirection'] = SortDirection +from apideck.model.leads_sort import LeadsSort + + +class TestLeadsSort(unittest.TestCase): + """LeadsSort unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testLeadsSort(self): + """Test LeadsSort""" + # FIXME: construct object with mandatory attributes with example values + # model = LeadsSort() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_ledger_account.py b/src/test/test_ledger_account.py new file mode 100644 index 0000000000..e87e6a081e --- /dev/null +++ b/src/test/test_ledger_account.py @@ -0,0 +1,45 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.bank_account import BankAccount +from apideck.model.currency import Currency +from apideck.model.ledger_account_categories import LedgerAccountCategories +from apideck.model.ledger_account_parent_account import LedgerAccountParentAccount +from apideck.model.linked_tax_rate import LinkedTaxRate +globals()['BankAccount'] = BankAccount +globals()['Currency'] = Currency +globals()['LedgerAccountCategories'] = LedgerAccountCategories +globals()['LedgerAccountParentAccount'] = LedgerAccountParentAccount +globals()['LinkedTaxRate'] = LinkedTaxRate +from apideck.model.ledger_account import LedgerAccount + + +class TestLedgerAccount(unittest.TestCase): + """LedgerAccount unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testLedgerAccount(self): + """Test LedgerAccount""" + # FIXME: construct object with mandatory attributes with example values + # model = LedgerAccount() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_ledger_account_categories.py b/src/test/test_ledger_account_categories.py new file mode 100644 index 0000000000..18aed070cd --- /dev/null +++ b/src/test/test_ledger_account_categories.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.ledger_account_categories import LedgerAccountCategories + + +class TestLedgerAccountCategories(unittest.TestCase): + """LedgerAccountCategories unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testLedgerAccountCategories(self): + """Test LedgerAccountCategories""" + # FIXME: construct object with mandatory attributes with example values + # model = LedgerAccountCategories() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_ledger_account_parent_account.py b/src/test/test_ledger_account_parent_account.py new file mode 100644 index 0000000000..1373482599 --- /dev/null +++ b/src/test/test_ledger_account_parent_account.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.ledger_account_parent_account import LedgerAccountParentAccount + + +class TestLedgerAccountParentAccount(unittest.TestCase): + """LedgerAccountParentAccount unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testLedgerAccountParentAccount(self): + """Test LedgerAccountParentAccount""" + # FIXME: construct object with mandatory attributes with example values + # model = LedgerAccountParentAccount() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_ledger_accounts.py b/src/test/test_ledger_accounts.py new file mode 100644 index 0000000000..f2522e8b68 --- /dev/null +++ b/src/test/test_ledger_accounts.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.ledger_account import LedgerAccount +globals()['LedgerAccount'] = LedgerAccount +from apideck.model.ledger_accounts import LedgerAccounts + + +class TestLedgerAccounts(unittest.TestCase): + """LedgerAccounts unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testLedgerAccounts(self): + """Test LedgerAccounts""" + # FIXME: construct object with mandatory attributes with example values + # model = LedgerAccounts() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_linked_connector_resource.py b/src/test/test_linked_connector_resource.py new file mode 100644 index 0000000000..bc75a2ac27 --- /dev/null +++ b/src/test/test_linked_connector_resource.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.resource_status import ResourceStatus +globals()['ResourceStatus'] = ResourceStatus +from apideck.model.linked_connector_resource import LinkedConnectorResource + + +class TestLinkedConnectorResource(unittest.TestCase): + """LinkedConnectorResource unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testLinkedConnectorResource(self): + """Test LinkedConnectorResource""" + # FIXME: construct object with mandatory attributes with example values + # model = LinkedConnectorResource() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_linked_customer.py b/src/test/test_linked_customer.py new file mode 100644 index 0000000000..090ed4f7c3 --- /dev/null +++ b/src/test/test_linked_customer.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.linked_customer import LinkedCustomer + + +class TestLinkedCustomer(unittest.TestCase): + """LinkedCustomer unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testLinkedCustomer(self): + """Test LinkedCustomer""" + # FIXME: construct object with mandatory attributes with example values + # model = LinkedCustomer() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_linked_folder.py b/src/test/test_linked_folder.py new file mode 100644 index 0000000000..d1bff4dddf --- /dev/null +++ b/src/test/test_linked_folder.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.linked_folder import LinkedFolder + + +class TestLinkedFolder(unittest.TestCase): + """LinkedFolder unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testLinkedFolder(self): + """Test LinkedFolder""" + # FIXME: construct object with mandatory attributes with example values + # model = LinkedFolder() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_linked_invoice_item.py b/src/test/test_linked_invoice_item.py new file mode 100644 index 0000000000..1a3aabfd5c --- /dev/null +++ b/src/test/test_linked_invoice_item.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.linked_invoice_item import LinkedInvoiceItem + + +class TestLinkedInvoiceItem(unittest.TestCase): + """LinkedInvoiceItem unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testLinkedInvoiceItem(self): + """Test LinkedInvoiceItem""" + # FIXME: construct object with mandatory attributes with example values + # model = LinkedInvoiceItem() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_linked_ledger_account.py b/src/test/test_linked_ledger_account.py new file mode 100644 index 0000000000..c03e41edf2 --- /dev/null +++ b/src/test/test_linked_ledger_account.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.linked_ledger_account import LinkedLedgerAccount + + +class TestLinkedLedgerAccount(unittest.TestCase): + """LinkedLedgerAccount unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testLinkedLedgerAccount(self): + """Test LinkedLedgerAccount""" + # FIXME: construct object with mandatory attributes with example values + # model = LinkedLedgerAccount() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_linked_supplier.py b/src/test/test_linked_supplier.py new file mode 100644 index 0000000000..efc73d44f3 --- /dev/null +++ b/src/test/test_linked_supplier.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.address import Address +globals()['Address'] = Address +from apideck.model.linked_supplier import LinkedSupplier + + +class TestLinkedSupplier(unittest.TestCase): + """LinkedSupplier unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testLinkedSupplier(self): + """Test LinkedSupplier""" + # FIXME: construct object with mandatory attributes with example values + # model = LinkedSupplier() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_linked_tax_rate.py b/src/test/test_linked_tax_rate.py new file mode 100644 index 0000000000..40a398fb61 --- /dev/null +++ b/src/test/test_linked_tax_rate.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.linked_tax_rate import LinkedTaxRate + + +class TestLinkedTaxRate(unittest.TestCase): + """LinkedTaxRate unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testLinkedTaxRate(self): + """Test LinkedTaxRate""" + # FIXME: construct object with mandatory attributes with example values + # model = LinkedTaxRate() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_links.py b/src/test/test_links.py new file mode 100644 index 0000000000..1fc7df0e47 --- /dev/null +++ b/src/test/test_links.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.links import Links + + +class TestLinks(unittest.TestCase): + """Links unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testLinks(self): + """Test Links""" + # FIXME: construct object with mandatory attributes with example values + # model = Links() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_location.py b/src/test/test_location.py new file mode 100644 index 0000000000..91355fdc2a --- /dev/null +++ b/src/test/test_location.py @@ -0,0 +1,39 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.address import Address +from apideck.model.currency import Currency +globals()['Address'] = Address +globals()['Currency'] = Currency +from apideck.model.location import Location + + +class TestLocation(unittest.TestCase): + """Location unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testLocation(self): + """Test Location""" + # FIXME: construct object with mandatory attributes with example values + # model = Location() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_log.py b/src/test/test_log.py new file mode 100644 index 0000000000..f8d1719a78 --- /dev/null +++ b/src/test/test_log.py @@ -0,0 +1,39 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.log_operation import LogOperation +from apideck.model.log_service import LogService +globals()['LogOperation'] = LogOperation +globals()['LogService'] = LogService +from apideck.model.log import Log + + +class TestLog(unittest.TestCase): + """Log unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testLog(self): + """Test Log""" + # FIXME: construct object with mandatory attributes with example values + # model = Log() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_log_operation.py b/src/test/test_log_operation.py new file mode 100644 index 0000000000..44dd30733f --- /dev/null +++ b/src/test/test_log_operation.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.log_operation import LogOperation + + +class TestLogOperation(unittest.TestCase): + """LogOperation unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testLogOperation(self): + """Test LogOperation""" + # FIXME: construct object with mandatory attributes with example values + # model = LogOperation() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_log_service.py b/src/test/test_log_service.py new file mode 100644 index 0000000000..d15545b56b --- /dev/null +++ b/src/test/test_log_service.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.log_service import LogService + + +class TestLogService(unittest.TestCase): + """LogService unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testLogService(self): + """Test LogService""" + # FIXME: construct object with mandatory attributes with example values + # model = LogService() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_logs_filter.py b/src/test/test_logs_filter.py new file mode 100644 index 0000000000..da544120c9 --- /dev/null +++ b/src/test/test_logs_filter.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.logs_filter import LogsFilter + + +class TestLogsFilter(unittest.TestCase): + """LogsFilter unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testLogsFilter(self): + """Test LogsFilter""" + # FIXME: construct object with mandatory attributes with example values + # model = LogsFilter() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_merchant.py b/src/test/test_merchant.py new file mode 100644 index 0000000000..e91c8f1208 --- /dev/null +++ b/src/test/test_merchant.py @@ -0,0 +1,41 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.address import Address +from apideck.model.currency import Currency +from apideck.model.service_charge import ServiceCharge +globals()['Address'] = Address +globals()['Currency'] = Currency +globals()['ServiceCharge'] = ServiceCharge +from apideck.model.merchant import Merchant + + +class TestMerchant(unittest.TestCase): + """Merchant unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testMerchant(self): + """Test Merchant""" + # FIXME: construct object with mandatory attributes with example values + # model = Merchant() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_message.py b/src/test/test_message.py new file mode 100644 index 0000000000..2528cff4b5 --- /dev/null +++ b/src/test/test_message.py @@ -0,0 +1,39 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.error import Error +from apideck.model.price import Price +globals()['Error'] = Error +globals()['Price'] = Price +from apideck.model.message import Message + + +class TestMessage(unittest.TestCase): + """Message unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testMessage(self): + """Test Message""" + # FIXME: construct object with mandatory attributes with example values + # model = Message() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_meta.py b/src/test/test_meta.py new file mode 100644 index 0000000000..451a0e6d23 --- /dev/null +++ b/src/test/test_meta.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.meta_cursors import MetaCursors +globals()['MetaCursors'] = MetaCursors +from apideck.model.meta import Meta + + +class TestMeta(unittest.TestCase): + """Meta unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testMeta(self): + """Test Meta""" + # FIXME: construct object with mandatory attributes with example values + # model = Meta() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_meta_cursors.py b/src/test/test_meta_cursors.py new file mode 100644 index 0000000000..8c77340d68 --- /dev/null +++ b/src/test/test_meta_cursors.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.meta_cursors import MetaCursors + + +class TestMetaCursors(unittest.TestCase): + """MetaCursors unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testMetaCursors(self): + """Test MetaCursors""" + # FIXME: construct object with mandatory attributes with example values + # model = MetaCursors() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_modifier.py b/src/test/test_modifier.py new file mode 100644 index 0000000000..6835663a2e --- /dev/null +++ b/src/test/test_modifier.py @@ -0,0 +1,39 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.currency import Currency +from apideck.model.idempotency_key import IdempotencyKey +globals()['Currency'] = Currency +globals()['IdempotencyKey'] = IdempotencyKey +from apideck.model.modifier import Modifier + + +class TestModifier(unittest.TestCase): + """Modifier unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testModifier(self): + """Test Modifier""" + # FIXME: construct object with mandatory attributes with example values + # model = Modifier() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_modifier_group.py b/src/test/test_modifier_group.py new file mode 100644 index 0000000000..eac9151dd9 --- /dev/null +++ b/src/test/test_modifier_group.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.modifier_group import ModifierGroup + + +class TestModifierGroup(unittest.TestCase): + """ModifierGroup unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testModifierGroup(self): + """Test ModifierGroup""" + # FIXME: construct object with mandatory attributes with example values + # model = ModifierGroup() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_modifier_group_filter.py b/src/test/test_modifier_group_filter.py new file mode 100644 index 0000000000..acf5c98bcd --- /dev/null +++ b/src/test/test_modifier_group_filter.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.modifier_group_filter import ModifierGroupFilter + + +class TestModifierGroupFilter(unittest.TestCase): + """ModifierGroupFilter unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testModifierGroupFilter(self): + """Test ModifierGroupFilter""" + # FIXME: construct object with mandatory attributes with example values + # model = ModifierGroupFilter() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_not_found_response.py b/src/test/test_not_found_response.py new file mode 100644 index 0000000000..c221525219 --- /dev/null +++ b/src/test/test_not_found_response.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.not_found_response import NotFoundResponse + + +class TestNotFoundResponse(unittest.TestCase): + """NotFoundResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testNotFoundResponse(self): + """Test NotFoundResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = NotFoundResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_not_implemented_response.py b/src/test/test_not_implemented_response.py new file mode 100644 index 0000000000..e9460cfd23 --- /dev/null +++ b/src/test/test_not_implemented_response.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.not_implemented_response import NotImplementedResponse + + +class TestNotImplementedResponse(unittest.TestCase): + """NotImplementedResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testNotImplementedResponse(self): + """Test NotImplementedResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = NotImplementedResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_note.py b/src/test/test_note.py new file mode 100644 index 0000000000..905321c494 --- /dev/null +++ b/src/test/test_note.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.note import Note + + +class TestNote(unittest.TestCase): + """Note unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testNote(self): + """Test Note""" + # FIXME: construct object with mandatory attributes with example values + # model = Note() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_o_auth_grant_type.py b/src/test/test_o_auth_grant_type.py new file mode 100644 index 0000000000..a9eb8b032a --- /dev/null +++ b/src/test/test_o_auth_grant_type.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.o_auth_grant_type import OAuthGrantType + + +class TestOAuthGrantType(unittest.TestCase): + """OAuthGrantType unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testOAuthGrantType(self): + """Test OAuthGrantType""" + # FIXME: construct object with mandatory attributes with example values + # model = OAuthGrantType() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_offer.py b/src/test/test_offer.py new file mode 100644 index 0000000000..fcdf4e7064 --- /dev/null +++ b/src/test/test_offer.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.offer import Offer + + +class TestOffer(unittest.TestCase): + """Offer unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testOffer(self): + """Test Offer""" + # FIXME: construct object with mandatory attributes with example values + # model = Offer() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_opportunities_filter.py b/src/test/test_opportunities_filter.py new file mode 100644 index 0000000000..43bce76d2c --- /dev/null +++ b/src/test/test_opportunities_filter.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.opportunities_filter import OpportunitiesFilter + + +class TestOpportunitiesFilter(unittest.TestCase): + """OpportunitiesFilter unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testOpportunitiesFilter(self): + """Test OpportunitiesFilter""" + # FIXME: construct object with mandatory attributes with example values + # model = OpportunitiesFilter() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_opportunities_sort.py b/src/test/test_opportunities_sort.py new file mode 100644 index 0000000000..b5d36afda0 --- /dev/null +++ b/src/test/test_opportunities_sort.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.sort_direction import SortDirection +globals()['SortDirection'] = SortDirection +from apideck.model.opportunities_sort import OpportunitiesSort + + +class TestOpportunitiesSort(unittest.TestCase): + """OpportunitiesSort unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testOpportunitiesSort(self): + """Test OpportunitiesSort""" + # FIXME: construct object with mandatory attributes with example values + # model = OpportunitiesSort() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_opportunity.py b/src/test/test_opportunity.py new file mode 100644 index 0000000000..fa1c07b540 --- /dev/null +++ b/src/test/test_opportunity.py @@ -0,0 +1,41 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.currency import Currency +from apideck.model.custom_field import CustomField +from apideck.model.tags import Tags +globals()['Currency'] = Currency +globals()['CustomField'] = CustomField +globals()['Tags'] = Tags +from apideck.model.opportunity import Opportunity + + +class TestOpportunity(unittest.TestCase): + """Opportunity unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testOpportunity(self): + """Test Opportunity""" + # FIXME: construct object with mandatory attributes with example values + # model = Opportunity() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_order.py b/src/test/test_order.py new file mode 100644 index 0000000000..62e521682d --- /dev/null +++ b/src/test/test_order.py @@ -0,0 +1,55 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.currency import Currency +from apideck.model.idempotency_key import IdempotencyKey +from apideck.model.order_customers import OrderCustomers +from apideck.model.order_discounts import OrderDiscounts +from apideck.model.order_fulfillments import OrderFulfillments +from apideck.model.order_line_items import OrderLineItems +from apideck.model.order_payments import OrderPayments +from apideck.model.order_refunds import OrderRefunds +from apideck.model.order_tenders import OrderTenders +from apideck.model.service_charges import ServiceCharges +globals()['Currency'] = Currency +globals()['IdempotencyKey'] = IdempotencyKey +globals()['OrderCustomers'] = OrderCustomers +globals()['OrderDiscounts'] = OrderDiscounts +globals()['OrderFulfillments'] = OrderFulfillments +globals()['OrderLineItems'] = OrderLineItems +globals()['OrderPayments'] = OrderPayments +globals()['OrderRefunds'] = OrderRefunds +globals()['OrderTenders'] = OrderTenders +globals()['ServiceCharges'] = ServiceCharges +from apideck.model.order import Order + + +class TestOrder(unittest.TestCase): + """Order unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testOrder(self): + """Test Order""" + # FIXME: construct object with mandatory attributes with example values + # model = Order() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_order_customers.py b/src/test/test_order_customers.py new file mode 100644 index 0000000000..6a5cdc9e4b --- /dev/null +++ b/src/test/test_order_customers.py @@ -0,0 +1,39 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.email import Email +from apideck.model.phone_number import PhoneNumber +globals()['Email'] = Email +globals()['PhoneNumber'] = PhoneNumber +from apideck.model.order_customers import OrderCustomers + + +class TestOrderCustomers(unittest.TestCase): + """OrderCustomers unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testOrderCustomers(self): + """Test OrderCustomers""" + # FIXME: construct object with mandatory attributes with example values + # model = OrderCustomers() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_order_discounts.py b/src/test/test_order_discounts.py new file mode 100644 index 0000000000..f87cc6a43d --- /dev/null +++ b/src/test/test_order_discounts.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.currency import Currency +globals()['Currency'] = Currency +from apideck.model.order_discounts import OrderDiscounts + + +class TestOrderDiscounts(unittest.TestCase): + """OrderDiscounts unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testOrderDiscounts(self): + """Test OrderDiscounts""" + # FIXME: construct object with mandatory attributes with example values + # model = OrderDiscounts() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_order_fulfillments.py b/src/test/test_order_fulfillments.py new file mode 100644 index 0000000000..c71f4305ea --- /dev/null +++ b/src/test/test_order_fulfillments.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.order_pickup_details import OrderPickupDetails +globals()['OrderPickupDetails'] = OrderPickupDetails +from apideck.model.order_fulfillments import OrderFulfillments + + +class TestOrderFulfillments(unittest.TestCase): + """OrderFulfillments unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testOrderFulfillments(self): + """Test OrderFulfillments""" + # FIXME: construct object with mandatory attributes with example values + # model = OrderFulfillments() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_order_line_items.py b/src/test/test_order_line_items.py new file mode 100644 index 0000000000..b48fded461 --- /dev/null +++ b/src/test/test_order_line_items.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.order_line_items import OrderLineItems + + +class TestOrderLineItems(unittest.TestCase): + """OrderLineItems unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testOrderLineItems(self): + """Test OrderLineItems""" + # FIXME: construct object with mandatory attributes with example values + # model = OrderLineItems() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_order_payments.py b/src/test/test_order_payments.py new file mode 100644 index 0000000000..438fd88a73 --- /dev/null +++ b/src/test/test_order_payments.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.currency import Currency +globals()['Currency'] = Currency +from apideck.model.order_payments import OrderPayments + + +class TestOrderPayments(unittest.TestCase): + """OrderPayments unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testOrderPayments(self): + """Test OrderPayments""" + # FIXME: construct object with mandatory attributes with example values + # model = OrderPayments() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_order_pickup_details.py b/src/test/test_order_pickup_details.py new file mode 100644 index 0000000000..88f17cd188 --- /dev/null +++ b/src/test/test_order_pickup_details.py @@ -0,0 +1,39 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.order_pickup_details_curbside_pickup_details import OrderPickupDetailsCurbsidePickupDetails +from apideck.model.order_pickup_details_recipient import OrderPickupDetailsRecipient +globals()['OrderPickupDetailsCurbsidePickupDetails'] = OrderPickupDetailsCurbsidePickupDetails +globals()['OrderPickupDetailsRecipient'] = OrderPickupDetailsRecipient +from apideck.model.order_pickup_details import OrderPickupDetails + + +class TestOrderPickupDetails(unittest.TestCase): + """OrderPickupDetails unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testOrderPickupDetails(self): + """Test OrderPickupDetails""" + # FIXME: construct object with mandatory attributes with example values + # model = OrderPickupDetails() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_order_pickup_details_curbside_pickup_details.py b/src/test/test_order_pickup_details_curbside_pickup_details.py new file mode 100644 index 0000000000..f87cd3d368 --- /dev/null +++ b/src/test/test_order_pickup_details_curbside_pickup_details.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.order_pickup_details_curbside_pickup_details import OrderPickupDetailsCurbsidePickupDetails + + +class TestOrderPickupDetailsCurbsidePickupDetails(unittest.TestCase): + """OrderPickupDetailsCurbsidePickupDetails unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testOrderPickupDetailsCurbsidePickupDetails(self): + """Test OrderPickupDetailsCurbsidePickupDetails""" + # FIXME: construct object with mandatory attributes with example values + # model = OrderPickupDetailsCurbsidePickupDetails() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_order_pickup_details_recipient.py b/src/test/test_order_pickup_details_recipient.py new file mode 100644 index 0000000000..9a723d7792 --- /dev/null +++ b/src/test/test_order_pickup_details_recipient.py @@ -0,0 +1,41 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.address import Address +from apideck.model.email import Email +from apideck.model.phone_number import PhoneNumber +globals()['Address'] = Address +globals()['Email'] = Email +globals()['PhoneNumber'] = PhoneNumber +from apideck.model.order_pickup_details_recipient import OrderPickupDetailsRecipient + + +class TestOrderPickupDetailsRecipient(unittest.TestCase): + """OrderPickupDetailsRecipient unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testOrderPickupDetailsRecipient(self): + """Test OrderPickupDetailsRecipient""" + # FIXME: construct object with mandatory attributes with example values + # model = OrderPickupDetailsRecipient() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_order_refunds.py b/src/test/test_order_refunds.py new file mode 100644 index 0000000000..8668aa9d7c --- /dev/null +++ b/src/test/test_order_refunds.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.currency import Currency +globals()['Currency'] = Currency +from apideck.model.order_refunds import OrderRefunds + + +class TestOrderRefunds(unittest.TestCase): + """OrderRefunds unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testOrderRefunds(self): + """Test OrderRefunds""" + # FIXME: construct object with mandatory attributes with example values + # model = OrderRefunds() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_order_tenders.py b/src/test/test_order_tenders.py new file mode 100644 index 0000000000..86b6195224 --- /dev/null +++ b/src/test/test_order_tenders.py @@ -0,0 +1,39 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.currency import Currency +from apideck.model.payment_card import PaymentCard +globals()['Currency'] = Currency +globals()['PaymentCard'] = PaymentCard +from apideck.model.order_tenders import OrderTenders + + +class TestOrderTenders(unittest.TestCase): + """OrderTenders unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testOrderTenders(self): + """Test OrderTenders""" + # FIXME: construct object with mandatory attributes with example values + # model = OrderTenders() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_order_type.py b/src/test/test_order_type.py new file mode 100644 index 0000000000..4bece53e9f --- /dev/null +++ b/src/test/test_order_type.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.order_type import OrderType + + +class TestOrderType(unittest.TestCase): + """OrderType unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testOrderType(self): + """Test OrderType""" + # FIXME: construct object with mandatory attributes with example values + # model = OrderType() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_owner.py b/src/test/test_owner.py new file mode 100644 index 0000000000..13030ac5a4 --- /dev/null +++ b/src/test/test_owner.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.owner import Owner + + +class TestOwner(unittest.TestCase): + """Owner unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testOwner(self): + """Test Owner""" + # FIXME: construct object with mandatory attributes with example values + # model = Owner() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_pagination_coverage.py b/src/test/test_pagination_coverage.py new file mode 100644 index 0000000000..11538216cc --- /dev/null +++ b/src/test/test_pagination_coverage.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.pagination_coverage import PaginationCoverage + + +class TestPaginationCoverage(unittest.TestCase): + """PaginationCoverage unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testPaginationCoverage(self): + """Test PaginationCoverage""" + # FIXME: construct object with mandatory attributes with example values + # model = PaginationCoverage() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_passthrough.py b/src/test/test_passthrough.py new file mode 100644 index 0000000000..8984dd7c93 --- /dev/null +++ b/src/test/test_passthrough.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.passthrough import Passthrough + + +class TestPassthrough(unittest.TestCase): + """Passthrough unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testPassthrough(self): + """Test Passthrough""" + # FIXME: construct object with mandatory attributes with example values + # model = Passthrough() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_payment.py b/src/test/test_payment.py new file mode 100644 index 0000000000..5746336022 --- /dev/null +++ b/src/test/test_payment.py @@ -0,0 +1,45 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.currency import Currency +from apideck.model.linked_customer import LinkedCustomer +from apideck.model.linked_ledger_account import LinkedLedgerAccount +from apideck.model.linked_supplier import LinkedSupplier +from apideck.model.payment_allocations import PaymentAllocations +globals()['Currency'] = Currency +globals()['LinkedCustomer'] = LinkedCustomer +globals()['LinkedLedgerAccount'] = LinkedLedgerAccount +globals()['LinkedSupplier'] = LinkedSupplier +globals()['PaymentAllocations'] = PaymentAllocations +from apideck.model.payment import Payment + + +class TestPayment(unittest.TestCase): + """Payment unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testPayment(self): + """Test Payment""" + # FIXME: construct object with mandatory attributes with example values + # model = Payment() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_payment_allocations.py b/src/test/test_payment_allocations.py new file mode 100644 index 0000000000..dc48be20e8 --- /dev/null +++ b/src/test/test_payment_allocations.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.payment_allocations import PaymentAllocations + + +class TestPaymentAllocations(unittest.TestCase): + """PaymentAllocations unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testPaymentAllocations(self): + """Test PaymentAllocations""" + # FIXME: construct object with mandatory attributes with example values + # model = PaymentAllocations() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_payment_card.py b/src/test/test_payment_card.py new file mode 100644 index 0000000000..9a06f1e251 --- /dev/null +++ b/src/test/test_payment_card.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.address import Address +globals()['Address'] = Address +from apideck.model.payment_card import PaymentCard + + +class TestPaymentCard(unittest.TestCase): + """PaymentCard unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testPaymentCard(self): + """Test PaymentCard""" + # FIXME: construct object with mandatory attributes with example values + # model = PaymentCard() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_payment_required_response.py b/src/test/test_payment_required_response.py new file mode 100644 index 0000000000..0be8593607 --- /dev/null +++ b/src/test/test_payment_required_response.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.payment_required_response import PaymentRequiredResponse + + +class TestPaymentRequiredResponse(unittest.TestCase): + """PaymentRequiredResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testPaymentRequiredResponse(self): + """Test PaymentRequiredResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = PaymentRequiredResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_payment_unit.py b/src/test/test_payment_unit.py new file mode 100644 index 0000000000..9a7eff927a --- /dev/null +++ b/src/test/test_payment_unit.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.payment_unit import PaymentUnit + + +class TestPaymentUnit(unittest.TestCase): + """PaymentUnit unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testPaymentUnit(self): + """Test PaymentUnit""" + # FIXME: construct object with mandatory attributes with example values + # model = PaymentUnit() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_payroll.py b/src/test/test_payroll.py new file mode 100644 index 0000000000..0f14be65af --- /dev/null +++ b/src/test/test_payroll.py @@ -0,0 +1,39 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.compensation import Compensation +from apideck.model.payroll_totals import PayrollTotals +globals()['Compensation'] = Compensation +globals()['PayrollTotals'] = PayrollTotals +from apideck.model.payroll import Payroll + + +class TestPayroll(unittest.TestCase): + """Payroll unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testPayroll(self): + """Test Payroll""" + # FIXME: construct object with mandatory attributes with example values + # model = Payroll() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_payroll_totals.py b/src/test/test_payroll_totals.py new file mode 100644 index 0000000000..49ad2a6b2c --- /dev/null +++ b/src/test/test_payroll_totals.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.payroll_totals import PayrollTotals + + +class TestPayrollTotals(unittest.TestCase): + """PayrollTotals unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testPayrollTotals(self): + """Test PayrollTotals""" + # FIXME: construct object with mandatory attributes with example values + # model = PayrollTotals() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_payrolls_filter.py b/src/test/test_payrolls_filter.py new file mode 100644 index 0000000000..78ce9f716d --- /dev/null +++ b/src/test/test_payrolls_filter.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.payrolls_filter import PayrollsFilter + + +class TestPayrollsFilter(unittest.TestCase): + """PayrollsFilter unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testPayrollsFilter(self): + """Test PayrollsFilter""" + # FIXME: construct object with mandatory attributes with example values + # model = PayrollsFilter() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_phone_number.py b/src/test/test_phone_number.py new file mode 100644 index 0000000000..460495d53d --- /dev/null +++ b/src/test/test_phone_number.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.phone_number import PhoneNumber + + +class TestPhoneNumber(unittest.TestCase): + """PhoneNumber unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testPhoneNumber(self): + """Test PhoneNumber""" + # FIXME: construct object with mandatory attributes with example values + # model = PhoneNumber() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_pipeline.py b/src/test/test_pipeline.py new file mode 100644 index 0000000000..eb18076828 --- /dev/null +++ b/src/test/test_pipeline.py @@ -0,0 +1,39 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.currency import Currency +from apideck.model.pipeline_stages import PipelineStages +globals()['Currency'] = Currency +globals()['PipelineStages'] = PipelineStages +from apideck.model.pipeline import Pipeline + + +class TestPipeline(unittest.TestCase): + """Pipeline unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testPipeline(self): + """Test Pipeline""" + # FIXME: construct object with mandatory attributes with example values + # model = Pipeline() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_pipeline_stages.py b/src/test/test_pipeline_stages.py new file mode 100644 index 0000000000..b88e7ce96b --- /dev/null +++ b/src/test/test_pipeline_stages.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.pipeline_stages import PipelineStages + + +class TestPipelineStages(unittest.TestCase): + """PipelineStages unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testPipelineStages(self): + """Test PipelineStages""" + # FIXME: construct object with mandatory attributes with example values + # model = PipelineStages() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_pos_api.py b/src/test/test_pos_api.py new file mode 100644 index 0000000000..5e05100f3f --- /dev/null +++ b/src/test/test_pos_api.py @@ -0,0 +1,350 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import apideck +from apideck.api.pos_api import PosApi # noqa: E501 + + +class TestPosApi(unittest.TestCase): + """PosApi unit test stubs""" + + def setUp(self): + self.api = PosApi() # noqa: E501 + + def tearDown(self): + pass + + def test_items_add(self): + """Test case for items_add + + Create Item # noqa: E501 + """ + pass + + def test_items_all(self): + """Test case for items_all + + List Items # noqa: E501 + """ + pass + + def test_items_delete(self): + """Test case for items_delete + + Delete Item # noqa: E501 + """ + pass + + def test_items_one(self): + """Test case for items_one + + Get Item # noqa: E501 + """ + pass + + def test_items_update(self): + """Test case for items_update + + Update Item # noqa: E501 + """ + pass + + def test_locations_add(self): + """Test case for locations_add + + Create Location # noqa: E501 + """ + pass + + def test_locations_all(self): + """Test case for locations_all + + List Locations # noqa: E501 + """ + pass + + def test_locations_delete(self): + """Test case for locations_delete + + Delete Location # noqa: E501 + """ + pass + + def test_locations_one(self): + """Test case for locations_one + + Get Location # noqa: E501 + """ + pass + + def test_locations_update(self): + """Test case for locations_update + + Update Location # noqa: E501 + """ + pass + + def test_merchants_add(self): + """Test case for merchants_add + + Create Merchant # noqa: E501 + """ + pass + + def test_merchants_all(self): + """Test case for merchants_all + + List Merchants # noqa: E501 + """ + pass + + def test_merchants_delete(self): + """Test case for merchants_delete + + Delete Merchant # noqa: E501 + """ + pass + + def test_merchants_one(self): + """Test case for merchants_one + + Get Merchant # noqa: E501 + """ + pass + + def test_merchants_update(self): + """Test case for merchants_update + + Update Merchant # noqa: E501 + """ + pass + + def test_modifier_groups_add(self): + """Test case for modifier_groups_add + + Create Modifier Group # noqa: E501 + """ + pass + + def test_modifier_groups_all(self): + """Test case for modifier_groups_all + + List Modifier Groups # noqa: E501 + """ + pass + + def test_modifier_groups_delete(self): + """Test case for modifier_groups_delete + + Delete Modifier Group # noqa: E501 + """ + pass + + def test_modifier_groups_one(self): + """Test case for modifier_groups_one + + Get Modifier Group # noqa: E501 + """ + pass + + def test_modifier_groups_update(self): + """Test case for modifier_groups_update + + Update Modifier Group # noqa: E501 + """ + pass + + def test_modifiers_add(self): + """Test case for modifiers_add + + Create Modifier # noqa: E501 + """ + pass + + def test_modifiers_all(self): + """Test case for modifiers_all + + List Modifiers # noqa: E501 + """ + pass + + def test_modifiers_delete(self): + """Test case for modifiers_delete + + Delete Modifier # noqa: E501 + """ + pass + + def test_modifiers_one(self): + """Test case for modifiers_one + + Get Modifier # noqa: E501 + """ + pass + + def test_modifiers_update(self): + """Test case for modifiers_update + + Update Modifier # noqa: E501 + """ + pass + + def test_order_types_add(self): + """Test case for order_types_add + + Create Order Type # noqa: E501 + """ + pass + + def test_order_types_all(self): + """Test case for order_types_all + + List Order Types # noqa: E501 + """ + pass + + def test_order_types_delete(self): + """Test case for order_types_delete + + Delete Order Type # noqa: E501 + """ + pass + + def test_order_types_one(self): + """Test case for order_types_one + + Get Order Type # noqa: E501 + """ + pass + + def test_order_types_update(self): + """Test case for order_types_update + + Update Order Type # noqa: E501 + """ + pass + + def test_orders_add(self): + """Test case for orders_add + + Create Order # noqa: E501 + """ + pass + + def test_orders_all(self): + """Test case for orders_all + + List Orders # noqa: E501 + """ + pass + + def test_orders_delete(self): + """Test case for orders_delete + + Delete Order # noqa: E501 + """ + pass + + def test_orders_one(self): + """Test case for orders_one + + Get Order # noqa: E501 + """ + pass + + def test_orders_pay(self): + """Test case for orders_pay + + Pay Order # noqa: E501 + """ + pass + + def test_orders_update(self): + """Test case for orders_update + + Update Order # noqa: E501 + """ + pass + + def test_payments_add(self): + """Test case for payments_add + + Create Payment # noqa: E501 + """ + pass + + def test_payments_all(self): + """Test case for payments_all + + List Payments # noqa: E501 + """ + pass + + def test_payments_delete(self): + """Test case for payments_delete + + Delete Payment # noqa: E501 + """ + pass + + def test_payments_one(self): + """Test case for payments_one + + Get Payment # noqa: E501 + """ + pass + + def test_payments_update(self): + """Test case for payments_update + + Update Payment # noqa: E501 + """ + pass + + def test_tenders_add(self): + """Test case for tenders_add + + Create Tender # noqa: E501 + """ + pass + + def test_tenders_all(self): + """Test case for tenders_all + + List Tenders # noqa: E501 + """ + pass + + def test_tenders_delete(self): + """Test case for tenders_delete + + Delete Tender # noqa: E501 + """ + pass + + def test_tenders_one(self): + """Test case for tenders_one + + Get Tender # noqa: E501 + """ + pass + + def test_tenders_update(self): + """Test case for tenders_update + + Update Tender # noqa: E501 + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_pos_bank_account.py b/src/test/test_pos_bank_account.py new file mode 100644 index 0000000000..5aef474921 --- /dev/null +++ b/src/test/test_pos_bank_account.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.pos_bank_account_ach_details import PosBankAccountAchDetails +globals()['PosBankAccountAchDetails'] = PosBankAccountAchDetails +from apideck.model.pos_bank_account import PosBankAccount + + +class TestPosBankAccount(unittest.TestCase): + """PosBankAccount unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testPosBankAccount(self): + """Test PosBankAccount""" + # FIXME: construct object with mandatory attributes with example values + # model = PosBankAccount() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_pos_bank_account_ach_details.py b/src/test/test_pos_bank_account_ach_details.py new file mode 100644 index 0000000000..34f34d38ce --- /dev/null +++ b/src/test/test_pos_bank_account_ach_details.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.pos_bank_account_ach_details import PosBankAccountAchDetails + + +class TestPosBankAccountAchDetails(unittest.TestCase): + """PosBankAccountAchDetails unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testPosBankAccountAchDetails(self): + """Test PosBankAccountAchDetails""" + # FIXME: construct object with mandatory attributes with example values + # model = PosBankAccountAchDetails() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_pos_payment.py b/src/test/test_pos_payment.py new file mode 100644 index 0000000000..7d5bf74bb3 --- /dev/null +++ b/src/test/test_pos_payment.py @@ -0,0 +1,51 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.cash_details import CashDetails +from apideck.model.currency import Currency +from apideck.model.idempotency_key import IdempotencyKey +from apideck.model.pos_bank_account import PosBankAccount +from apideck.model.pos_payment_card_details import PosPaymentCardDetails +from apideck.model.pos_payment_external_details import PosPaymentExternalDetails +from apideck.model.service_charges import ServiceCharges +from apideck.model.wallet_details import WalletDetails +globals()['CashDetails'] = CashDetails +globals()['Currency'] = Currency +globals()['IdempotencyKey'] = IdempotencyKey +globals()['PosBankAccount'] = PosBankAccount +globals()['PosPaymentCardDetails'] = PosPaymentCardDetails +globals()['PosPaymentExternalDetails'] = PosPaymentExternalDetails +globals()['ServiceCharges'] = ServiceCharges +globals()['WalletDetails'] = WalletDetails +from apideck.model.pos_payment import PosPayment + + +class TestPosPayment(unittest.TestCase): + """PosPayment unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testPosPayment(self): + """Test PosPayment""" + # FIXME: construct object with mandatory attributes with example values + # model = PosPayment() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_pos_payment_card_details.py b/src/test/test_pos_payment_card_details.py new file mode 100644 index 0000000000..4edd0a978e --- /dev/null +++ b/src/test/test_pos_payment_card_details.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.payment_card import PaymentCard +globals()['PaymentCard'] = PaymentCard +from apideck.model.pos_payment_card_details import PosPaymentCardDetails + + +class TestPosPaymentCardDetails(unittest.TestCase): + """PosPaymentCardDetails unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testPosPaymentCardDetails(self): + """Test PosPaymentCardDetails""" + # FIXME: construct object with mandatory attributes with example values + # model = PosPaymentCardDetails() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_pos_payment_external_details.py b/src/test/test_pos_payment_external_details.py new file mode 100644 index 0000000000..e56e56706b --- /dev/null +++ b/src/test/test_pos_payment_external_details.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.pos_payment_external_details import PosPaymentExternalDetails + + +class TestPosPaymentExternalDetails(unittest.TestCase): + """PosPaymentExternalDetails unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testPosPaymentExternalDetails(self): + """Test PosPaymentExternalDetails""" + # FIXME: construct object with mandatory attributes with example values + # model = PosPaymentExternalDetails() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_price.py b/src/test/test_price.py new file mode 100644 index 0000000000..d2155f909e --- /dev/null +++ b/src/test/test_price.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.currency import Currency +globals()['Currency'] = Currency +from apideck.model.price import Price + + +class TestPrice(unittest.TestCase): + """Price unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testPrice(self): + """Test Price""" + # FIXME: construct object with mandatory attributes with example values + # model = Price() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_profit_and_loss.py b/src/test/test_profit_and_loss.py new file mode 100644 index 0000000000..98d4022ab0 --- /dev/null +++ b/src/test/test_profit_and_loss.py @@ -0,0 +1,45 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.profit_and_loss_expenses import ProfitAndLossExpenses +from apideck.model.profit_and_loss_gross_profit import ProfitAndLossGrossProfit +from apideck.model.profit_and_loss_income import ProfitAndLossIncome +from apideck.model.profit_and_loss_net_income import ProfitAndLossNetIncome +from apideck.model.profit_and_loss_net_operating_income import ProfitAndLossNetOperatingIncome +globals()['ProfitAndLossExpenses'] = ProfitAndLossExpenses +globals()['ProfitAndLossGrossProfit'] = ProfitAndLossGrossProfit +globals()['ProfitAndLossIncome'] = ProfitAndLossIncome +globals()['ProfitAndLossNetIncome'] = ProfitAndLossNetIncome +globals()['ProfitAndLossNetOperatingIncome'] = ProfitAndLossNetOperatingIncome +from apideck.model.profit_and_loss import ProfitAndLoss + + +class TestProfitAndLoss(unittest.TestCase): + """ProfitAndLoss unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testProfitAndLoss(self): + """Test ProfitAndLoss""" + # FIXME: construct object with mandatory attributes with example values + # model = ProfitAndLoss() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_profit_and_loss_expenses.py b/src/test/test_profit_and_loss_expenses.py new file mode 100644 index 0000000000..3b9e7bb210 --- /dev/null +++ b/src/test/test_profit_and_loss_expenses.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.profit_and_loss_records import ProfitAndLossRecords +globals()['ProfitAndLossRecords'] = ProfitAndLossRecords +from apideck.model.profit_and_loss_expenses import ProfitAndLossExpenses + + +class TestProfitAndLossExpenses(unittest.TestCase): + """ProfitAndLossExpenses unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testProfitAndLossExpenses(self): + """Test ProfitAndLossExpenses""" + # FIXME: construct object with mandatory attributes with example values + # model = ProfitAndLossExpenses() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_profit_and_loss_filter.py b/src/test/test_profit_and_loss_filter.py new file mode 100644 index 0000000000..b9fae112eb --- /dev/null +++ b/src/test/test_profit_and_loss_filter.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.profit_and_loss_filter import ProfitAndLossFilter + + +class TestProfitAndLossFilter(unittest.TestCase): + """ProfitAndLossFilter unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testProfitAndLossFilter(self): + """Test ProfitAndLossFilter""" + # FIXME: construct object with mandatory attributes with example values + # model = ProfitAndLossFilter() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_profit_and_loss_gross_profit.py b/src/test/test_profit_and_loss_gross_profit.py new file mode 100644 index 0000000000..3865eda648 --- /dev/null +++ b/src/test/test_profit_and_loss_gross_profit.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.profit_and_loss_records import ProfitAndLossRecords +globals()['ProfitAndLossRecords'] = ProfitAndLossRecords +from apideck.model.profit_and_loss_gross_profit import ProfitAndLossGrossProfit + + +class TestProfitAndLossGrossProfit(unittest.TestCase): + """ProfitAndLossGrossProfit unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testProfitAndLossGrossProfit(self): + """Test ProfitAndLossGrossProfit""" + # FIXME: construct object with mandatory attributes with example values + # model = ProfitAndLossGrossProfit() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_profit_and_loss_income.py b/src/test/test_profit_and_loss_income.py new file mode 100644 index 0000000000..254300c253 --- /dev/null +++ b/src/test/test_profit_and_loss_income.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.profit_and_loss_records import ProfitAndLossRecords +globals()['ProfitAndLossRecords'] = ProfitAndLossRecords +from apideck.model.profit_and_loss_income import ProfitAndLossIncome + + +class TestProfitAndLossIncome(unittest.TestCase): + """ProfitAndLossIncome unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testProfitAndLossIncome(self): + """Test ProfitAndLossIncome""" + # FIXME: construct object with mandatory attributes with example values + # model = ProfitAndLossIncome() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_profit_and_loss_net_income.py b/src/test/test_profit_and_loss_net_income.py new file mode 100644 index 0000000000..fe01d5a46a --- /dev/null +++ b/src/test/test_profit_and_loss_net_income.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.profit_and_loss_records import ProfitAndLossRecords +globals()['ProfitAndLossRecords'] = ProfitAndLossRecords +from apideck.model.profit_and_loss_net_income import ProfitAndLossNetIncome + + +class TestProfitAndLossNetIncome(unittest.TestCase): + """ProfitAndLossNetIncome unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testProfitAndLossNetIncome(self): + """Test ProfitAndLossNetIncome""" + # FIXME: construct object with mandatory attributes with example values + # model = ProfitAndLossNetIncome() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_profit_and_loss_net_operating_income.py b/src/test/test_profit_and_loss_net_operating_income.py new file mode 100644 index 0000000000..7e747dc7ca --- /dev/null +++ b/src/test/test_profit_and_loss_net_operating_income.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.profit_and_loss_records import ProfitAndLossRecords +globals()['ProfitAndLossRecords'] = ProfitAndLossRecords +from apideck.model.profit_and_loss_net_operating_income import ProfitAndLossNetOperatingIncome + + +class TestProfitAndLossNetOperatingIncome(unittest.TestCase): + """ProfitAndLossNetOperatingIncome unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testProfitAndLossNetOperatingIncome(self): + """Test ProfitAndLossNetOperatingIncome""" + # FIXME: construct object with mandatory attributes with example values + # model = ProfitAndLossNetOperatingIncome() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_profit_and_loss_record.py b/src/test/test_profit_and_loss_record.py new file mode 100644 index 0000000000..bcb9425d80 --- /dev/null +++ b/src/test/test_profit_and_loss_record.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.profit_and_loss_record import ProfitAndLossRecord + + +class TestProfitAndLossRecord(unittest.TestCase): + """ProfitAndLossRecord unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testProfitAndLossRecord(self): + """Test ProfitAndLossRecord""" + # FIXME: construct object with mandatory attributes with example values + # model = ProfitAndLossRecord() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_profit_and_loss_records.py b/src/test/test_profit_and_loss_records.py new file mode 100644 index 0000000000..6bcf6a3567 --- /dev/null +++ b/src/test/test_profit_and_loss_records.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.profit_and_loss_records import ProfitAndLossRecords + + +class TestProfitAndLossRecords(unittest.TestCase): + """ProfitAndLossRecords unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testProfitAndLossRecords(self): + """Test ProfitAndLossRecords""" + # FIXME: construct object with mandatory attributes with example values + # model = ProfitAndLossRecords() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_profit_and_loss_section.py b/src/test/test_profit_and_loss_section.py new file mode 100644 index 0000000000..8e8b51150d --- /dev/null +++ b/src/test/test_profit_and_loss_section.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.profit_and_loss_records import ProfitAndLossRecords +globals()['ProfitAndLossRecords'] = ProfitAndLossRecords +from apideck.model.profit_and_loss_section import ProfitAndLossSection + + +class TestProfitAndLossSection(unittest.TestCase): + """ProfitAndLossSection unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testProfitAndLossSection(self): + """Test ProfitAndLossSection""" + # FIXME: construct object with mandatory attributes with example values + # model = ProfitAndLossSection() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_request_count_allocation.py b/src/test/test_request_count_allocation.py new file mode 100644 index 0000000000..2f7c010106 --- /dev/null +++ b/src/test/test_request_count_allocation.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.request_count_allocation import RequestCountAllocation + + +class TestRequestCountAllocation(unittest.TestCase): + """RequestCountAllocation unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testRequestCountAllocation(self): + """Test RequestCountAllocation""" + # FIXME: construct object with mandatory attributes with example values + # model = RequestCountAllocation() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_resolve_webhook_event_request.py b/src/test/test_resolve_webhook_event_request.py new file mode 100644 index 0000000000..efa8a24993 --- /dev/null +++ b/src/test/test_resolve_webhook_event_request.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.resolve_webhook_event_request import ResolveWebhookEventRequest + + +class TestResolveWebhookEventRequest(unittest.TestCase): + """ResolveWebhookEventRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testResolveWebhookEventRequest(self): + """Test ResolveWebhookEventRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = ResolveWebhookEventRequest() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_resolve_webhook_events_request.py b/src/test/test_resolve_webhook_events_request.py new file mode 100644 index 0000000000..ede266152f --- /dev/null +++ b/src/test/test_resolve_webhook_events_request.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.resolve_webhook_events_request import ResolveWebhookEventsRequest + + +class TestResolveWebhookEventsRequest(unittest.TestCase): + """ResolveWebhookEventsRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testResolveWebhookEventsRequest(self): + """Test ResolveWebhookEventsRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = ResolveWebhookEventsRequest() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_resolve_webhook_response.py b/src/test/test_resolve_webhook_response.py new file mode 100644 index 0000000000..006f1a83c9 --- /dev/null +++ b/src/test/test_resolve_webhook_response.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.resolve_webhook_response import ResolveWebhookResponse + + +class TestResolveWebhookResponse(unittest.TestCase): + """ResolveWebhookResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testResolveWebhookResponse(self): + """Test ResolveWebhookResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = ResolveWebhookResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_resource_status.py b/src/test/test_resource_status.py new file mode 100644 index 0000000000..959bc5e42c --- /dev/null +++ b/src/test/test_resource_status.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.resource_status import ResourceStatus + + +class TestResourceStatus(unittest.TestCase): + """ResourceStatus unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testResourceStatus(self): + """Test ResourceStatus""" + # FIXME: construct object with mandatory attributes with example values + # model = ResourceStatus() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_schedule.py b/src/test/test_schedule.py new file mode 100644 index 0000000000..93fac920ec --- /dev/null +++ b/src/test/test_schedule.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.schedule_work_pattern import ScheduleWorkPattern +globals()['ScheduleWorkPattern'] = ScheduleWorkPattern +from apideck.model.schedule import Schedule + + +class TestSchedule(unittest.TestCase): + """Schedule unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testSchedule(self): + """Test Schedule""" + # FIXME: construct object with mandatory attributes with example values + # model = Schedule() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_schedule_work_pattern.py b/src/test/test_schedule_work_pattern.py new file mode 100644 index 0000000000..8528df4f13 --- /dev/null +++ b/src/test/test_schedule_work_pattern.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.schedule_work_pattern_odd_weeks import ScheduleWorkPatternOddWeeks +globals()['ScheduleWorkPatternOddWeeks'] = ScheduleWorkPatternOddWeeks +from apideck.model.schedule_work_pattern import ScheduleWorkPattern + + +class TestScheduleWorkPattern(unittest.TestCase): + """ScheduleWorkPattern unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testScheduleWorkPattern(self): + """Test ScheduleWorkPattern""" + # FIXME: construct object with mandatory attributes with example values + # model = ScheduleWorkPattern() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_schedule_work_pattern_odd_weeks.py b/src/test/test_schedule_work_pattern_odd_weeks.py new file mode 100644 index 0000000000..c395aaa80b --- /dev/null +++ b/src/test/test_schedule_work_pattern_odd_weeks.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.schedule_work_pattern_odd_weeks import ScheduleWorkPatternOddWeeks + + +class TestScheduleWorkPatternOddWeeks(unittest.TestCase): + """ScheduleWorkPatternOddWeeks unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testScheduleWorkPatternOddWeeks(self): + """Test ScheduleWorkPatternOddWeeks""" + # FIXME: construct object with mandatory attributes with example values + # model = ScheduleWorkPatternOddWeeks() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_service_charge.py b/src/test/test_service_charge.py new file mode 100644 index 0000000000..c38e907c9a --- /dev/null +++ b/src/test/test_service_charge.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.currency import Currency +globals()['Currency'] = Currency +from apideck.model.service_charge import ServiceCharge + + +class TestServiceCharge(unittest.TestCase): + """ServiceCharge unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testServiceCharge(self): + """Test ServiceCharge""" + # FIXME: construct object with mandatory attributes with example values + # model = ServiceCharge() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_service_charges.py b/src/test/test_service_charges.py new file mode 100644 index 0000000000..d777cfc4ba --- /dev/null +++ b/src/test/test_service_charges.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.service_charge import ServiceCharge +globals()['ServiceCharge'] = ServiceCharge +from apideck.model.service_charges import ServiceCharges + + +class TestServiceCharges(unittest.TestCase): + """ServiceCharges unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testServiceCharges(self): + """Test ServiceCharges""" + # FIXME: construct object with mandatory attributes with example values + # model = ServiceCharges() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_session.py b/src/test/test_session.py new file mode 100644 index 0000000000..cb6867d2e5 --- /dev/null +++ b/src/test/test_session.py @@ -0,0 +1,41 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.consumer_metadata import ConsumerMetadata +from apideck.model.session_settings import SessionSettings +from apideck.model.session_theme import SessionTheme +globals()['ConsumerMetadata'] = ConsumerMetadata +globals()['SessionSettings'] = SessionSettings +globals()['SessionTheme'] = SessionTheme +from apideck.model.session import Session + + +class TestSession(unittest.TestCase): + """Session unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testSession(self): + """Test Session""" + # FIXME: construct object with mandatory attributes with example values + # model = Session() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_session_settings.py b/src/test/test_session_settings.py new file mode 100644 index 0000000000..f83f52bddd --- /dev/null +++ b/src/test/test_session_settings.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_api_id import UnifiedApiId +globals()['UnifiedApiId'] = UnifiedApiId +from apideck.model.session_settings import SessionSettings + + +class TestSessionSettings(unittest.TestCase): + """SessionSettings unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testSessionSettings(self): + """Test SessionSettings""" + # FIXME: construct object with mandatory attributes with example values + # model = SessionSettings() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_session_theme.py b/src/test/test_session_theme.py new file mode 100644 index 0000000000..754fe7aa95 --- /dev/null +++ b/src/test/test_session_theme.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.session_theme import SessionTheme + + +class TestSessionTheme(unittest.TestCase): + """SessionTheme unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testSessionTheme(self): + """Test SessionTheme""" + # FIXME: construct object with mandatory attributes with example values + # model = SessionTheme() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_shared_link.py b/src/test/test_shared_link.py new file mode 100644 index 0000000000..e9b62297a6 --- /dev/null +++ b/src/test/test_shared_link.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.shared_link_target import SharedLinkTarget +globals()['SharedLinkTarget'] = SharedLinkTarget +from apideck.model.shared_link import SharedLink + + +class TestSharedLink(unittest.TestCase): + """SharedLink unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testSharedLink(self): + """Test SharedLink""" + # FIXME: construct object with mandatory attributes with example values + # model = SharedLink() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_shared_link_target.py b/src/test/test_shared_link_target.py new file mode 100644 index 0000000000..d81ea10200 --- /dev/null +++ b/src/test/test_shared_link_target.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.file_type import FileType +globals()['FileType'] = FileType +from apideck.model.shared_link_target import SharedLinkTarget + + +class TestSharedLinkTarget(unittest.TestCase): + """SharedLinkTarget unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testSharedLinkTarget(self): + """Test SharedLinkTarget""" + # FIXME: construct object with mandatory attributes with example values + # model = SharedLinkTarget() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_simple_form_field_option.py b/src/test/test_simple_form_field_option.py new file mode 100644 index 0000000000..d2b9b7c6ec --- /dev/null +++ b/src/test/test_simple_form_field_option.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.simple_form_field_option import SimpleFormFieldOption + + +class TestSimpleFormFieldOption(unittest.TestCase): + """SimpleFormFieldOption unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testSimpleFormFieldOption(self): + """Test SimpleFormFieldOption""" + # FIXME: construct object with mandatory attributes with example values + # model = SimpleFormFieldOption() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_sms_api.py b/src/test/test_sms_api.py new file mode 100644 index 0000000000..dd200338ae --- /dev/null +++ b/src/test/test_sms_api.py @@ -0,0 +1,63 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import apideck +from apideck.api.sms_api import SmsApi # noqa: E501 + + +class TestSmsApi(unittest.TestCase): + """SmsApi unit test stubs""" + + def setUp(self): + self.api = SmsApi() # noqa: E501 + + def tearDown(self): + pass + + def test_messages_add(self): + """Test case for messages_add + + Create Message # noqa: E501 + """ + pass + + def test_messages_all(self): + """Test case for messages_all + + List Messages # noqa: E501 + """ + pass + + def test_messages_delete(self): + """Test case for messages_delete + + Delete Message # noqa: E501 + """ + pass + + def test_messages_one(self): + """Test case for messages_one + + Get Message # noqa: E501 + """ + pass + + def test_messages_update(self): + """Test case for messages_update + + Update Message # noqa: E501 + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_social_link.py b/src/test/test_social_link.py new file mode 100644 index 0000000000..b75049245d --- /dev/null +++ b/src/test/test_social_link.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.social_link import SocialLink + + +class TestSocialLink(unittest.TestCase): + """SocialLink unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testSocialLink(self): + """Test SocialLink""" + # FIXME: construct object with mandatory attributes with example values + # model = SocialLink() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_sort_direction.py b/src/test/test_sort_direction.py new file mode 100644 index 0000000000..3480406181 --- /dev/null +++ b/src/test/test_sort_direction.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.sort_direction import SortDirection + + +class TestSortDirection(unittest.TestCase): + """SortDirection unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testSortDirection(self): + """Test SortDirection""" + # FIXME: construct object with mandatory attributes with example values + # model = SortDirection() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_status.py b/src/test/test_status.py new file mode 100644 index 0000000000..b9492c786c --- /dev/null +++ b/src/test/test_status.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.status import Status + + +class TestStatus(unittest.TestCase): + """Status unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testStatus(self): + """Test Status""" + # FIXME: construct object with mandatory attributes with example values + # model = Status() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_supplier.py b/src/test/test_supplier.py new file mode 100644 index 0000000000..e97083c747 --- /dev/null +++ b/src/test/test_supplier.py @@ -0,0 +1,51 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.address import Address +from apideck.model.bank_account import BankAccount +from apideck.model.currency import Currency +from apideck.model.email import Email +from apideck.model.linked_ledger_account import LinkedLedgerAccount +from apideck.model.linked_tax_rate import LinkedTaxRate +from apideck.model.phone_number import PhoneNumber +from apideck.model.website import Website +globals()['Address'] = Address +globals()['BankAccount'] = BankAccount +globals()['Currency'] = Currency +globals()['Email'] = Email +globals()['LinkedLedgerAccount'] = LinkedLedgerAccount +globals()['LinkedTaxRate'] = LinkedTaxRate +globals()['PhoneNumber'] = PhoneNumber +globals()['Website'] = Website +from apideck.model.supplier import Supplier + + +class TestSupplier(unittest.TestCase): + """Supplier unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testSupplier(self): + """Test Supplier""" + # FIXME: construct object with mandatory attributes with example values + # model = Supplier() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_supported_property.py b/src/test/test_supported_property.py new file mode 100644 index 0000000000..209370f410 --- /dev/null +++ b/src/test/test_supported_property.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.supported_property_child_properties import SupportedPropertyChildProperties +globals()['SupportedPropertyChildProperties'] = SupportedPropertyChildProperties +from apideck.model.supported_property import SupportedProperty + + +class TestSupportedProperty(unittest.TestCase): + """SupportedProperty unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testSupportedProperty(self): + """Test SupportedProperty""" + # FIXME: construct object with mandatory attributes with example values + # model = SupportedProperty() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_supported_property_child_properties.py b/src/test/test_supported_property_child_properties.py new file mode 100644 index 0000000000..c56499fd72 --- /dev/null +++ b/src/test/test_supported_property_child_properties.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.supported_property import SupportedProperty +globals()['SupportedProperty'] = SupportedProperty +from apideck.model.supported_property_child_properties import SupportedPropertyChildProperties + + +class TestSupportedPropertyChildProperties(unittest.TestCase): + """SupportedPropertyChildProperties unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testSupportedPropertyChildProperties(self): + """Test SupportedPropertyChildProperties""" + # FIXME: construct object with mandatory attributes with example values + # model = SupportedPropertyChildProperties() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_tags.py b/src/test/test_tags.py new file mode 100644 index 0000000000..c7c8bb7e34 --- /dev/null +++ b/src/test/test_tags.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.tags import Tags + + +class TestTags(unittest.TestCase): + """Tags unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testTags(self): + """Test Tags""" + # FIXME: construct object with mandatory attributes with example values + # model = Tags() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_tax.py b/src/test/test_tax.py new file mode 100644 index 0000000000..a704740cf6 --- /dev/null +++ b/src/test/test_tax.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.tax import Tax + + +class TestTax(unittest.TestCase): + """Tax unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testTax(self): + """Test Tax""" + # FIXME: construct object with mandatory attributes with example values + # model = Tax() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_tax_rate.py b/src/test/test_tax_rate.py new file mode 100644 index 0000000000..6fbd19ef23 --- /dev/null +++ b/src/test/test_tax_rate.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.tax_rate import TaxRate + + +class TestTaxRate(unittest.TestCase): + """TaxRate unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testTaxRate(self): + """Test TaxRate""" + # FIXME: construct object with mandatory attributes with example values + # model = TaxRate() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_tax_rates_filter.py b/src/test/test_tax_rates_filter.py new file mode 100644 index 0000000000..2ee4207810 --- /dev/null +++ b/src/test/test_tax_rates_filter.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.tax_rates_filter import TaxRatesFilter + + +class TestTaxRatesFilter(unittest.TestCase): + """TaxRatesFilter unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testTaxRatesFilter(self): + """Test TaxRatesFilter""" + # FIXME: construct object with mandatory attributes with example values + # model = TaxRatesFilter() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_tender.py b/src/test/test_tender.py new file mode 100644 index 0000000000..0e4806431a --- /dev/null +++ b/src/test/test_tender.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.tender import Tender + + +class TestTender(unittest.TestCase): + """Tender unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testTender(self): + """Test Tender""" + # FIXME: construct object with mandatory attributes with example values + # model = Tender() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_time_off_request.py b/src/test/test_time_off_request.py new file mode 100644 index 0000000000..2cfdc5f96e --- /dev/null +++ b/src/test/test_time_off_request.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.time_off_request_notes import TimeOffRequestNotes +globals()['TimeOffRequestNotes'] = TimeOffRequestNotes +from apideck.model.time_off_request import TimeOffRequest + + +class TestTimeOffRequest(unittest.TestCase): + """TimeOffRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testTimeOffRequest(self): + """Test TimeOffRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = TimeOffRequest() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_time_off_request_notes.py b/src/test/test_time_off_request_notes.py new file mode 100644 index 0000000000..496ed331dc --- /dev/null +++ b/src/test/test_time_off_request_notes.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.time_off_request_notes import TimeOffRequestNotes + + +class TestTimeOffRequestNotes(unittest.TestCase): + """TimeOffRequestNotes unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testTimeOffRequestNotes(self): + """Test TimeOffRequestNotes""" + # FIXME: construct object with mandatory attributes with example values + # model = TimeOffRequestNotes() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_time_off_requests_filter.py b/src/test/test_time_off_requests_filter.py new file mode 100644 index 0000000000..7438906c46 --- /dev/null +++ b/src/test/test_time_off_requests_filter.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.time_off_requests_filter import TimeOffRequestsFilter + + +class TestTimeOffRequestsFilter(unittest.TestCase): + """TimeOffRequestsFilter unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testTimeOffRequestsFilter(self): + """Test TimeOffRequestsFilter""" + # FIXME: construct object with mandatory attributes with example values + # model = TimeOffRequestsFilter() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_too_many_requests_response.py b/src/test/test_too_many_requests_response.py new file mode 100644 index 0000000000..5a264837e6 --- /dev/null +++ b/src/test/test_too_many_requests_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.too_many_requests_response_detail import TooManyRequestsResponseDetail +globals()['TooManyRequestsResponseDetail'] = TooManyRequestsResponseDetail +from apideck.model.too_many_requests_response import TooManyRequestsResponse + + +class TestTooManyRequestsResponse(unittest.TestCase): + """TooManyRequestsResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testTooManyRequestsResponse(self): + """Test TooManyRequestsResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = TooManyRequestsResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_too_many_requests_response_detail.py b/src/test/test_too_many_requests_response_detail.py new file mode 100644 index 0000000000..8e522e21dd --- /dev/null +++ b/src/test/test_too_many_requests_response_detail.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.too_many_requests_response_detail import TooManyRequestsResponseDetail + + +class TestTooManyRequestsResponseDetail(unittest.TestCase): + """TooManyRequestsResponseDetail unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testTooManyRequestsResponseDetail(self): + """Test TooManyRequestsResponseDetail""" + # FIXME: construct object with mandatory attributes with example values + # model = TooManyRequestsResponseDetail() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_unauthorized_response.py b/src/test/test_unauthorized_response.py new file mode 100644 index 0000000000..0de8780017 --- /dev/null +++ b/src/test/test_unauthorized_response.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unauthorized_response import UnauthorizedResponse + + +class TestUnauthorizedResponse(unittest.TestCase): + """UnauthorizedResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testUnauthorizedResponse(self): + """Test UnauthorizedResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = UnauthorizedResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_unexpected_error_response.py b/src/test/test_unexpected_error_response.py new file mode 100644 index 0000000000..37a9eabfb9 --- /dev/null +++ b/src/test/test_unexpected_error_response.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unexpected_error_response import UnexpectedErrorResponse + + +class TestUnexpectedErrorResponse(unittest.TestCase): + """UnexpectedErrorResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testUnexpectedErrorResponse(self): + """Test UnexpectedErrorResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = UnexpectedErrorResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_unified_api_id.py b/src/test/test_unified_api_id.py new file mode 100644 index 0000000000..80b5f02fcc --- /dev/null +++ b/src/test/test_unified_api_id.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_api_id import UnifiedApiId + + +class TestUnifiedApiId(unittest.TestCase): + """UnifiedApiId unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testUnifiedApiId(self): + """Test UnifiedApiId""" + # FIXME: construct object with mandatory attributes with example values + # model = UnifiedApiId() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_unified_file.py b/src/test/test_unified_file.py new file mode 100644 index 0000000000..c0b2b86d16 --- /dev/null +++ b/src/test/test_unified_file.py @@ -0,0 +1,41 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.file_type import FileType +from apideck.model.linked_folder import LinkedFolder +from apideck.model.owner import Owner +globals()['FileType'] = FileType +globals()['LinkedFolder'] = LinkedFolder +globals()['Owner'] = Owner +from apideck.model.unified_file import UnifiedFile + + +class TestUnifiedFile(unittest.TestCase): + """UnifiedFile unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testUnifiedFile(self): + """Test UnifiedFile""" + # FIXME: construct object with mandatory attributes with example values + # model = UnifiedFile() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_unified_id.py b/src/test/test_unified_id.py new file mode 100644 index 0000000000..6a31b77429 --- /dev/null +++ b/src/test/test_unified_id.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId + + +class TestUnifiedId(unittest.TestCase): + """UnifiedId unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testUnifiedId(self): + """Test UnifiedId""" + # FIXME: construct object with mandatory attributes with example values + # model = UnifiedId() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_unprocessable_response.py b/src/test/test_unprocessable_response.py new file mode 100644 index 0000000000..08ed34043c --- /dev/null +++ b/src/test/test_unprocessable_response.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unprocessable_response import UnprocessableResponse + + +class TestUnprocessableResponse(unittest.TestCase): + """UnprocessableResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testUnprocessableResponse(self): + """Test UnprocessableResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = UnprocessableResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_update_activity_response.py b/src/test/test_update_activity_response.py new file mode 100644 index 0000000000..75ce8396ce --- /dev/null +++ b/src/test/test_update_activity_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId +globals()['UnifiedId'] = UnifiedId +from apideck.model.update_activity_response import UpdateActivityResponse + + +class TestUpdateActivityResponse(unittest.TestCase): + """UpdateActivityResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testUpdateActivityResponse(self): + """Test UpdateActivityResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = UpdateActivityResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_update_bill_response.py b/src/test/test_update_bill_response.py new file mode 100644 index 0000000000..228adb781d --- /dev/null +++ b/src/test/test_update_bill_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId +globals()['UnifiedId'] = UnifiedId +from apideck.model.update_bill_response import UpdateBillResponse + + +class TestUpdateBillResponse(unittest.TestCase): + """UpdateBillResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testUpdateBillResponse(self): + """Test UpdateBillResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = UpdateBillResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_update_company_response.py b/src/test/test_update_company_response.py new file mode 100644 index 0000000000..537e23b69b --- /dev/null +++ b/src/test/test_update_company_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId +globals()['UnifiedId'] = UnifiedId +from apideck.model.update_company_response import UpdateCompanyResponse + + +class TestUpdateCompanyResponse(unittest.TestCase): + """UpdateCompanyResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testUpdateCompanyResponse(self): + """Test UpdateCompanyResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = UpdateCompanyResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_update_connection_response.py b/src/test/test_update_connection_response.py new file mode 100644 index 0000000000..9266c98008 --- /dev/null +++ b/src/test/test_update_connection_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.connection import Connection +globals()['Connection'] = Connection +from apideck.model.update_connection_response import UpdateConnectionResponse + + +class TestUpdateConnectionResponse(unittest.TestCase): + """UpdateConnectionResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testUpdateConnectionResponse(self): + """Test UpdateConnectionResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = UpdateConnectionResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_update_contact_response.py b/src/test/test_update_contact_response.py new file mode 100644 index 0000000000..bee56460bb --- /dev/null +++ b/src/test/test_update_contact_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId +globals()['UnifiedId'] = UnifiedId +from apideck.model.update_contact_response import UpdateContactResponse + + +class TestUpdateContactResponse(unittest.TestCase): + """UpdateContactResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testUpdateContactResponse(self): + """Test UpdateContactResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = UpdateContactResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_update_credit_note_response.py b/src/test/test_update_credit_note_response.py new file mode 100644 index 0000000000..46a5f0b1cf --- /dev/null +++ b/src/test/test_update_credit_note_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId +globals()['UnifiedId'] = UnifiedId +from apideck.model.update_credit_note_response import UpdateCreditNoteResponse + + +class TestUpdateCreditNoteResponse(unittest.TestCase): + """UpdateCreditNoteResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testUpdateCreditNoteResponse(self): + """Test UpdateCreditNoteResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = UpdateCreditNoteResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_update_customer_response.py b/src/test/test_update_customer_response.py new file mode 100644 index 0000000000..0edb0ecf4e --- /dev/null +++ b/src/test/test_update_customer_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId +globals()['UnifiedId'] = UnifiedId +from apideck.model.update_customer_response import UpdateCustomerResponse + + +class TestUpdateCustomerResponse(unittest.TestCase): + """UpdateCustomerResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testUpdateCustomerResponse(self): + """Test UpdateCustomerResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = UpdateCustomerResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_update_customer_support_customer_response.py b/src/test/test_update_customer_support_customer_response.py new file mode 100644 index 0000000000..ae0e54fbd4 --- /dev/null +++ b/src/test/test_update_customer_support_customer_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId +globals()['UnifiedId'] = UnifiedId +from apideck.model.update_customer_support_customer_response import UpdateCustomerSupportCustomerResponse + + +class TestUpdateCustomerSupportCustomerResponse(unittest.TestCase): + """UpdateCustomerSupportCustomerResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testUpdateCustomerSupportCustomerResponse(self): + """Test UpdateCustomerSupportCustomerResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = UpdateCustomerSupportCustomerResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_update_department_response.py b/src/test/test_update_department_response.py new file mode 100644 index 0000000000..eb10ba8774 --- /dev/null +++ b/src/test/test_update_department_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId +globals()['UnifiedId'] = UnifiedId +from apideck.model.update_department_response import UpdateDepartmentResponse + + +class TestUpdateDepartmentResponse(unittest.TestCase): + """UpdateDepartmentResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testUpdateDepartmentResponse(self): + """Test UpdateDepartmentResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = UpdateDepartmentResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_update_drive_group_response.py b/src/test/test_update_drive_group_response.py new file mode 100644 index 0000000000..9aa6620324 --- /dev/null +++ b/src/test/test_update_drive_group_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId +globals()['UnifiedId'] = UnifiedId +from apideck.model.update_drive_group_response import UpdateDriveGroupResponse + + +class TestUpdateDriveGroupResponse(unittest.TestCase): + """UpdateDriveGroupResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testUpdateDriveGroupResponse(self): + """Test UpdateDriveGroupResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = UpdateDriveGroupResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_update_drive_response.py b/src/test/test_update_drive_response.py new file mode 100644 index 0000000000..4562aac0f3 --- /dev/null +++ b/src/test/test_update_drive_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId +globals()['UnifiedId'] = UnifiedId +from apideck.model.update_drive_response import UpdateDriveResponse + + +class TestUpdateDriveResponse(unittest.TestCase): + """UpdateDriveResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testUpdateDriveResponse(self): + """Test UpdateDriveResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = UpdateDriveResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_update_employee_response.py b/src/test/test_update_employee_response.py new file mode 100644 index 0000000000..75c8a6274e --- /dev/null +++ b/src/test/test_update_employee_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId +globals()['UnifiedId'] = UnifiedId +from apideck.model.update_employee_response import UpdateEmployeeResponse + + +class TestUpdateEmployeeResponse(unittest.TestCase): + """UpdateEmployeeResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testUpdateEmployeeResponse(self): + """Test UpdateEmployeeResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = UpdateEmployeeResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_update_file_response.py b/src/test/test_update_file_response.py new file mode 100644 index 0000000000..3cfc6f4035 --- /dev/null +++ b/src/test/test_update_file_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId +globals()['UnifiedId'] = UnifiedId +from apideck.model.update_file_response import UpdateFileResponse + + +class TestUpdateFileResponse(unittest.TestCase): + """UpdateFileResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testUpdateFileResponse(self): + """Test UpdateFileResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = UpdateFileResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_update_folder_request.py b/src/test/test_update_folder_request.py new file mode 100644 index 0000000000..4ef9455ada --- /dev/null +++ b/src/test/test_update_folder_request.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.update_folder_request import UpdateFolderRequest + + +class TestUpdateFolderRequest(unittest.TestCase): + """UpdateFolderRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testUpdateFolderRequest(self): + """Test UpdateFolderRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = UpdateFolderRequest() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_update_folder_response.py b/src/test/test_update_folder_response.py new file mode 100644 index 0000000000..9e0948a909 --- /dev/null +++ b/src/test/test_update_folder_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId +globals()['UnifiedId'] = UnifiedId +from apideck.model.update_folder_response import UpdateFolderResponse + + +class TestUpdateFolderResponse(unittest.TestCase): + """UpdateFolderResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testUpdateFolderResponse(self): + """Test UpdateFolderResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = UpdateFolderResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_update_hris_company_response.py b/src/test/test_update_hris_company_response.py new file mode 100644 index 0000000000..b8f9125ad3 --- /dev/null +++ b/src/test/test_update_hris_company_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId +globals()['UnifiedId'] = UnifiedId +from apideck.model.update_hris_company_response import UpdateHrisCompanyResponse + + +class TestUpdateHrisCompanyResponse(unittest.TestCase): + """UpdateHrisCompanyResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testUpdateHrisCompanyResponse(self): + """Test UpdateHrisCompanyResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = UpdateHrisCompanyResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_update_invoice_items_response.py b/src/test/test_update_invoice_items_response.py new file mode 100644 index 0000000000..cc5908b881 --- /dev/null +++ b/src/test/test_update_invoice_items_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId +globals()['UnifiedId'] = UnifiedId +from apideck.model.update_invoice_items_response import UpdateInvoiceItemsResponse + + +class TestUpdateInvoiceItemsResponse(unittest.TestCase): + """UpdateInvoiceItemsResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testUpdateInvoiceItemsResponse(self): + """Test UpdateInvoiceItemsResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = UpdateInvoiceItemsResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_update_invoice_response.py b/src/test/test_update_invoice_response.py new file mode 100644 index 0000000000..c2aa33349f --- /dev/null +++ b/src/test/test_update_invoice_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.invoice_response import InvoiceResponse +globals()['InvoiceResponse'] = InvoiceResponse +from apideck.model.update_invoice_response import UpdateInvoiceResponse + + +class TestUpdateInvoiceResponse(unittest.TestCase): + """UpdateInvoiceResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testUpdateInvoiceResponse(self): + """Test UpdateInvoiceResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = UpdateInvoiceResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_update_item_response.py b/src/test/test_update_item_response.py new file mode 100644 index 0000000000..6034e0dc79 --- /dev/null +++ b/src/test/test_update_item_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId +globals()['UnifiedId'] = UnifiedId +from apideck.model.update_item_response import UpdateItemResponse + + +class TestUpdateItemResponse(unittest.TestCase): + """UpdateItemResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testUpdateItemResponse(self): + """Test UpdateItemResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = UpdateItemResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_update_job_response.py b/src/test/test_update_job_response.py new file mode 100644 index 0000000000..1a0f7da47b --- /dev/null +++ b/src/test/test_update_job_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId +globals()['UnifiedId'] = UnifiedId +from apideck.model.update_job_response import UpdateJobResponse + + +class TestUpdateJobResponse(unittest.TestCase): + """UpdateJobResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testUpdateJobResponse(self): + """Test UpdateJobResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = UpdateJobResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_update_lead_response.py b/src/test/test_update_lead_response.py new file mode 100644 index 0000000000..d65ca5783f --- /dev/null +++ b/src/test/test_update_lead_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId +globals()['UnifiedId'] = UnifiedId +from apideck.model.update_lead_response import UpdateLeadResponse + + +class TestUpdateLeadResponse(unittest.TestCase): + """UpdateLeadResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testUpdateLeadResponse(self): + """Test UpdateLeadResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = UpdateLeadResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_update_ledger_account_response.py b/src/test/test_update_ledger_account_response.py new file mode 100644 index 0000000000..f4dfd518b1 --- /dev/null +++ b/src/test/test_update_ledger_account_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId +globals()['UnifiedId'] = UnifiedId +from apideck.model.update_ledger_account_response import UpdateLedgerAccountResponse + + +class TestUpdateLedgerAccountResponse(unittest.TestCase): + """UpdateLedgerAccountResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testUpdateLedgerAccountResponse(self): + """Test UpdateLedgerAccountResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = UpdateLedgerAccountResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_update_location_response.py b/src/test/test_update_location_response.py new file mode 100644 index 0000000000..de52e4641f --- /dev/null +++ b/src/test/test_update_location_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId +globals()['UnifiedId'] = UnifiedId +from apideck.model.update_location_response import UpdateLocationResponse + + +class TestUpdateLocationResponse(unittest.TestCase): + """UpdateLocationResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testUpdateLocationResponse(self): + """Test UpdateLocationResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = UpdateLocationResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_update_merchant_response.py b/src/test/test_update_merchant_response.py new file mode 100644 index 0000000000..c8e05f13f3 --- /dev/null +++ b/src/test/test_update_merchant_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId +globals()['UnifiedId'] = UnifiedId +from apideck.model.update_merchant_response import UpdateMerchantResponse + + +class TestUpdateMerchantResponse(unittest.TestCase): + """UpdateMerchantResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testUpdateMerchantResponse(self): + """Test UpdateMerchantResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = UpdateMerchantResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_update_message_response.py b/src/test/test_update_message_response.py new file mode 100644 index 0000000000..d291f82041 --- /dev/null +++ b/src/test/test_update_message_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId +globals()['UnifiedId'] = UnifiedId +from apideck.model.update_message_response import UpdateMessageResponse + + +class TestUpdateMessageResponse(unittest.TestCase): + """UpdateMessageResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testUpdateMessageResponse(self): + """Test UpdateMessageResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = UpdateMessageResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_update_modifier_group_response.py b/src/test/test_update_modifier_group_response.py new file mode 100644 index 0000000000..ebb19bf627 --- /dev/null +++ b/src/test/test_update_modifier_group_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId +globals()['UnifiedId'] = UnifiedId +from apideck.model.update_modifier_group_response import UpdateModifierGroupResponse + + +class TestUpdateModifierGroupResponse(unittest.TestCase): + """UpdateModifierGroupResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testUpdateModifierGroupResponse(self): + """Test UpdateModifierGroupResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = UpdateModifierGroupResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_update_modifier_response.py b/src/test/test_update_modifier_response.py new file mode 100644 index 0000000000..07600a5534 --- /dev/null +++ b/src/test/test_update_modifier_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId +globals()['UnifiedId'] = UnifiedId +from apideck.model.update_modifier_response import UpdateModifierResponse + + +class TestUpdateModifierResponse(unittest.TestCase): + """UpdateModifierResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testUpdateModifierResponse(self): + """Test UpdateModifierResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = UpdateModifierResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_update_note_response.py b/src/test/test_update_note_response.py new file mode 100644 index 0000000000..ce1d112f8d --- /dev/null +++ b/src/test/test_update_note_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId +globals()['UnifiedId'] = UnifiedId +from apideck.model.update_note_response import UpdateNoteResponse + + +class TestUpdateNoteResponse(unittest.TestCase): + """UpdateNoteResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testUpdateNoteResponse(self): + """Test UpdateNoteResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = UpdateNoteResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_update_opportunity_response.py b/src/test/test_update_opportunity_response.py new file mode 100644 index 0000000000..efb59d8bd7 --- /dev/null +++ b/src/test/test_update_opportunity_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId +globals()['UnifiedId'] = UnifiedId +from apideck.model.update_opportunity_response import UpdateOpportunityResponse + + +class TestUpdateOpportunityResponse(unittest.TestCase): + """UpdateOpportunityResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testUpdateOpportunityResponse(self): + """Test UpdateOpportunityResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = UpdateOpportunityResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_update_order_response.py b/src/test/test_update_order_response.py new file mode 100644 index 0000000000..cb4d77dc1a --- /dev/null +++ b/src/test/test_update_order_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId +globals()['UnifiedId'] = UnifiedId +from apideck.model.update_order_response import UpdateOrderResponse + + +class TestUpdateOrderResponse(unittest.TestCase): + """UpdateOrderResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testUpdateOrderResponse(self): + """Test UpdateOrderResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = UpdateOrderResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_update_order_type_response.py b/src/test/test_update_order_type_response.py new file mode 100644 index 0000000000..de806e1765 --- /dev/null +++ b/src/test/test_update_order_type_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId +globals()['UnifiedId'] = UnifiedId +from apideck.model.update_order_type_response import UpdateOrderTypeResponse + + +class TestUpdateOrderTypeResponse(unittest.TestCase): + """UpdateOrderTypeResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testUpdateOrderTypeResponse(self): + """Test UpdateOrderTypeResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = UpdateOrderTypeResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_update_payment_response.py b/src/test/test_update_payment_response.py new file mode 100644 index 0000000000..d47709fe09 --- /dev/null +++ b/src/test/test_update_payment_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId +globals()['UnifiedId'] = UnifiedId +from apideck.model.update_payment_response import UpdatePaymentResponse + + +class TestUpdatePaymentResponse(unittest.TestCase): + """UpdatePaymentResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testUpdatePaymentResponse(self): + """Test UpdatePaymentResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = UpdatePaymentResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_update_pipeline_response.py b/src/test/test_update_pipeline_response.py new file mode 100644 index 0000000000..064d1ebebe --- /dev/null +++ b/src/test/test_update_pipeline_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId +globals()['UnifiedId'] = UnifiedId +from apideck.model.update_pipeline_response import UpdatePipelineResponse + + +class TestUpdatePipelineResponse(unittest.TestCase): + """UpdatePipelineResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testUpdatePipelineResponse(self): + """Test UpdatePipelineResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = UpdatePipelineResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_update_pos_payment_response.py b/src/test/test_update_pos_payment_response.py new file mode 100644 index 0000000000..8188f747ea --- /dev/null +++ b/src/test/test_update_pos_payment_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId +globals()['UnifiedId'] = UnifiedId +from apideck.model.update_pos_payment_response import UpdatePosPaymentResponse + + +class TestUpdatePosPaymentResponse(unittest.TestCase): + """UpdatePosPaymentResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testUpdatePosPaymentResponse(self): + """Test UpdatePosPaymentResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = UpdatePosPaymentResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_update_shared_link_response.py b/src/test/test_update_shared_link_response.py new file mode 100644 index 0000000000..d76946d91e --- /dev/null +++ b/src/test/test_update_shared_link_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId +globals()['UnifiedId'] = UnifiedId +from apideck.model.update_shared_link_response import UpdateSharedLinkResponse + + +class TestUpdateSharedLinkResponse(unittest.TestCase): + """UpdateSharedLinkResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testUpdateSharedLinkResponse(self): + """Test UpdateSharedLinkResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = UpdateSharedLinkResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_update_supplier_response.py b/src/test/test_update_supplier_response.py new file mode 100644 index 0000000000..dad67ece37 --- /dev/null +++ b/src/test/test_update_supplier_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId +globals()['UnifiedId'] = UnifiedId +from apideck.model.update_supplier_response import UpdateSupplierResponse + + +class TestUpdateSupplierResponse(unittest.TestCase): + """UpdateSupplierResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testUpdateSupplierResponse(self): + """Test UpdateSupplierResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = UpdateSupplierResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_update_tax_rate_response.py b/src/test/test_update_tax_rate_response.py new file mode 100644 index 0000000000..2aa84def89 --- /dev/null +++ b/src/test/test_update_tax_rate_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId +globals()['UnifiedId'] = UnifiedId +from apideck.model.update_tax_rate_response import UpdateTaxRateResponse + + +class TestUpdateTaxRateResponse(unittest.TestCase): + """UpdateTaxRateResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testUpdateTaxRateResponse(self): + """Test UpdateTaxRateResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = UpdateTaxRateResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_update_tender_response.py b/src/test/test_update_tender_response.py new file mode 100644 index 0000000000..0d0be2818b --- /dev/null +++ b/src/test/test_update_tender_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId +globals()['UnifiedId'] = UnifiedId +from apideck.model.update_tender_response import UpdateTenderResponse + + +class TestUpdateTenderResponse(unittest.TestCase): + """UpdateTenderResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testUpdateTenderResponse(self): + """Test UpdateTenderResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = UpdateTenderResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_update_time_off_request_response.py b/src/test/test_update_time_off_request_response.py new file mode 100644 index 0000000000..f745c53594 --- /dev/null +++ b/src/test/test_update_time_off_request_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId +globals()['UnifiedId'] = UnifiedId +from apideck.model.update_time_off_request_response import UpdateTimeOffRequestResponse + + +class TestUpdateTimeOffRequestResponse(unittest.TestCase): + """UpdateTimeOffRequestResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testUpdateTimeOffRequestResponse(self): + """Test UpdateTimeOffRequestResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = UpdateTimeOffRequestResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_update_upload_session_response.py b/src/test/test_update_upload_session_response.py new file mode 100644 index 0000000000..43d7838b61 --- /dev/null +++ b/src/test/test_update_upload_session_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId +globals()['UnifiedId'] = UnifiedId +from apideck.model.update_upload_session_response import UpdateUploadSessionResponse + + +class TestUpdateUploadSessionResponse(unittest.TestCase): + """UpdateUploadSessionResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testUpdateUploadSessionResponse(self): + """Test UpdateUploadSessionResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = UpdateUploadSessionResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_update_user_response.py b/src/test/test_update_user_response.py new file mode 100644 index 0000000000..a2c5961e6e --- /dev/null +++ b/src/test/test_update_user_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_id import UnifiedId +globals()['UnifiedId'] = UnifiedId +from apideck.model.update_user_response import UpdateUserResponse + + +class TestUpdateUserResponse(unittest.TestCase): + """UpdateUserResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testUpdateUserResponse(self): + """Test UpdateUserResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = UpdateUserResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_update_webhook_request.py b/src/test/test_update_webhook_request.py new file mode 100644 index 0000000000..377f35990d --- /dev/null +++ b/src/test/test_update_webhook_request.py @@ -0,0 +1,41 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.delivery_url import DeliveryUrl +from apideck.model.status import Status +from apideck.model.webhook_event_type import WebhookEventType +globals()['DeliveryUrl'] = DeliveryUrl +globals()['Status'] = Status +globals()['WebhookEventType'] = WebhookEventType +from apideck.model.update_webhook_request import UpdateWebhookRequest + + +class TestUpdateWebhookRequest(unittest.TestCase): + """UpdateWebhookRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testUpdateWebhookRequest(self): + """Test UpdateWebhookRequest""" + # FIXME: construct object with mandatory attributes with example values + # model = UpdateWebhookRequest() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_update_webhook_response.py b/src/test/test_update_webhook_response.py new file mode 100644 index 0000000000..0752692e2f --- /dev/null +++ b/src/test/test_update_webhook_response.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.webhook import Webhook +globals()['Webhook'] = Webhook +from apideck.model.update_webhook_response import UpdateWebhookResponse + + +class TestUpdateWebhookResponse(unittest.TestCase): + """UpdateWebhookResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testUpdateWebhookResponse(self): + """Test UpdateWebhookResponse""" + # FIXME: construct object with mandatory attributes with example values + # model = UpdateWebhookResponse() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_upload_session.py b/src/test/test_upload_session.py new file mode 100644 index 0000000000..fbab37c09e --- /dev/null +++ b/src/test/test_upload_session.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.upload_session import UploadSession + + +class TestUploadSession(unittest.TestCase): + """UploadSession unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testUploadSession(self): + """Test UploadSession""" + # FIXME: construct object with mandatory attributes with example values + # model = UploadSession() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_url.py b/src/test/test_url.py new file mode 100644 index 0000000000..86e1002bcd --- /dev/null +++ b/src/test/test_url.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.url import Url + + +class TestUrl(unittest.TestCase): + """Url unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testUrl(self): + """Test Url""" + # FIXME: construct object with mandatory attributes with example values + # model = Url() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_user.py b/src/test/test_user.py new file mode 100644 index 0000000000..235e833d50 --- /dev/null +++ b/src/test/test_user.py @@ -0,0 +1,41 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.address import Address +from apideck.model.email import Email +from apideck.model.phone_number import PhoneNumber +globals()['Address'] = Address +globals()['Email'] = Email +globals()['PhoneNumber'] = PhoneNumber +from apideck.model.user import User + + +class TestUser(unittest.TestCase): + """User unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testUser(self): + """Test User""" + # FIXME: construct object with mandatory attributes with example values + # model = User() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_vault_api.py b/src/test/test_vault_api.py new file mode 100644 index 0000000000..2a2b1081ee --- /dev/null +++ b/src/test/test_vault_api.py @@ -0,0 +1,112 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import apideck +from apideck.api.vault_api import VaultApi # noqa: E501 + + +class TestVaultApi(unittest.TestCase): + """VaultApi unit test stubs""" + + def setUp(self): + self.api = VaultApi() # noqa: E501 + + def tearDown(self): + pass + + def test_connection_settings_all(self): + """Test case for connection_settings_all + + Get resource settings # noqa: E501 + """ + pass + + def test_connection_settings_update(self): + """Test case for connection_settings_update + + Update settings # noqa: E501 + """ + pass + + def test_connections_all(self): + """Test case for connections_all + + Get all connections # noqa: E501 + """ + pass + + def test_connections_delete(self): + """Test case for connections_delete + + Deletes a connection # noqa: E501 + """ + pass + + def test_connections_import(self): + """Test case for connections_import + + Import connection # noqa: E501 + """ + pass + + def test_connections_one(self): + """Test case for connections_one + + Get connection # noqa: E501 + """ + pass + + def test_connections_update(self): + """Test case for connections_update + + Update connection # noqa: E501 + """ + pass + + def test_consumer_request_counts_all(self): + """Test case for consumer_request_counts_all + + Consumer request counts # noqa: E501 + """ + pass + + def test_consumers_all(self): + """Test case for consumers_all + + Get all consumers # noqa: E501 + """ + pass + + def test_consumers_one(self): + """Test case for consumers_one + + Get consumer # noqa: E501 + """ + pass + + def test_logs_all(self): + """Test case for logs_all + + Get all consumer request logs # noqa: E501 + """ + pass + + def test_sessions_create(self): + """Test case for sessions_create + + Create Session # noqa: E501 + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_vault_event_type.py b/src/test/test_vault_event_type.py new file mode 100644 index 0000000000..6c6b3147cd --- /dev/null +++ b/src/test/test_vault_event_type.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.vault_event_type import VaultEventType + + +class TestVaultEventType(unittest.TestCase): + """VaultEventType unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testVaultEventType(self): + """Test VaultEventType""" + # FIXME: construct object with mandatory attributes with example values + # model = VaultEventType() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_wallet_details.py b/src/test/test_wallet_details.py new file mode 100644 index 0000000000..35d61783cc --- /dev/null +++ b/src/test/test_wallet_details.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.wallet_details import WalletDetails + + +class TestWalletDetails(unittest.TestCase): + """WalletDetails unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testWalletDetails(self): + """Test WalletDetails""" + # FIXME: construct object with mandatory attributes with example values + # model = WalletDetails() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_webhook.py b/src/test/test_webhook.py new file mode 100644 index 0000000000..63ec6d65b3 --- /dev/null +++ b/src/test/test_webhook.py @@ -0,0 +1,45 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.delivery_url import DeliveryUrl +from apideck.model.execute_base_url import ExecuteBaseUrl +from apideck.model.status import Status +from apideck.model.unified_api_id import UnifiedApiId +from apideck.model.webhook_event_type import WebhookEventType +globals()['DeliveryUrl'] = DeliveryUrl +globals()['ExecuteBaseUrl'] = ExecuteBaseUrl +globals()['Status'] = Status +globals()['UnifiedApiId'] = UnifiedApiId +globals()['WebhookEventType'] = WebhookEventType +from apideck.model.webhook import Webhook + + +class TestWebhook(unittest.TestCase): + """Webhook unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testWebhook(self): + """Test Webhook""" + # FIXME: construct object with mandatory attributes with example values + # model = Webhook() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_webhook_api.py b/src/test/test_webhook_api.py new file mode 100644 index 0000000000..d3842c6888 --- /dev/null +++ b/src/test/test_webhook_api.py @@ -0,0 +1,70 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import apideck +from apideck.api.webhook_api import WebhookApi # noqa: E501 + + +class TestWebhookApi(unittest.TestCase): + """WebhookApi unit test stubs""" + + def setUp(self): + self.api = WebhookApi() # noqa: E501 + + def tearDown(self): + pass + + def test_event_logs_all(self): + """Test case for event_logs_all + + List event logs # noqa: E501 + """ + pass + + def test_webhooks_add(self): + """Test case for webhooks_add + + Create webhook subscription # noqa: E501 + """ + pass + + def test_webhooks_all(self): + """Test case for webhooks_all + + List webhook subscriptions # noqa: E501 + """ + pass + + def test_webhooks_delete(self): + """Test case for webhooks_delete + + Delete webhook subscription # noqa: E501 + """ + pass + + def test_webhooks_one(self): + """Test case for webhooks_one + + Get webhook subscription # noqa: E501 + """ + pass + + def test_webhooks_update(self): + """Test case for webhooks_update + + Update webhook subscription # noqa: E501 + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_webhook_event_log.py b/src/test/test_webhook_event_log.py new file mode 100644 index 0000000000..1fc0b45c69 --- /dev/null +++ b/src/test/test_webhook_event_log.py @@ -0,0 +1,41 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.unified_api_id import UnifiedApiId +from apideck.model.webhook_event_log_attempts import WebhookEventLogAttempts +from apideck.model.webhook_event_log_service import WebhookEventLogService +globals()['UnifiedApiId'] = UnifiedApiId +globals()['WebhookEventLogAttempts'] = WebhookEventLogAttempts +globals()['WebhookEventLogService'] = WebhookEventLogService +from apideck.model.webhook_event_log import WebhookEventLog + + +class TestWebhookEventLog(unittest.TestCase): + """WebhookEventLog unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testWebhookEventLog(self): + """Test WebhookEventLog""" + # FIXME: construct object with mandatory attributes with example values + # model = WebhookEventLog() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_webhook_event_log_attempts.py b/src/test/test_webhook_event_log_attempts.py new file mode 100644 index 0000000000..a3c623cf43 --- /dev/null +++ b/src/test/test_webhook_event_log_attempts.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.webhook_event_log_attempts import WebhookEventLogAttempts + + +class TestWebhookEventLogAttempts(unittest.TestCase): + """WebhookEventLogAttempts unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testWebhookEventLogAttempts(self): + """Test WebhookEventLogAttempts""" + # FIXME: construct object with mandatory attributes with example values + # model = WebhookEventLogAttempts() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_webhook_event_log_service.py b/src/test/test_webhook_event_log_service.py new file mode 100644 index 0000000000..9bf7335335 --- /dev/null +++ b/src/test/test_webhook_event_log_service.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.webhook_event_log_service import WebhookEventLogService + + +class TestWebhookEventLogService(unittest.TestCase): + """WebhookEventLogService unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testWebhookEventLogService(self): + """Test WebhookEventLogService""" + # FIXME: construct object with mandatory attributes with example values + # model = WebhookEventLogService() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_webhook_event_logs_filter.py b/src/test/test_webhook_event_logs_filter.py new file mode 100644 index 0000000000..1eeb1325ee --- /dev/null +++ b/src/test/test_webhook_event_logs_filter.py @@ -0,0 +1,37 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.webhook_event_logs_filter_service import WebhookEventLogsFilterService +globals()['WebhookEventLogsFilterService'] = WebhookEventLogsFilterService +from apideck.model.webhook_event_logs_filter import WebhookEventLogsFilter + + +class TestWebhookEventLogsFilter(unittest.TestCase): + """WebhookEventLogsFilter unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testWebhookEventLogsFilter(self): + """Test WebhookEventLogsFilter""" + # FIXME: construct object with mandatory attributes with example values + # model = WebhookEventLogsFilter() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_webhook_event_logs_filter_service.py b/src/test/test_webhook_event_logs_filter_service.py new file mode 100644 index 0000000000..491ef9c468 --- /dev/null +++ b/src/test/test_webhook_event_logs_filter_service.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.webhook_event_logs_filter_service import WebhookEventLogsFilterService + + +class TestWebhookEventLogsFilterService(unittest.TestCase): + """WebhookEventLogsFilterService unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testWebhookEventLogsFilterService(self): + """Test WebhookEventLogsFilterService""" + # FIXME: construct object with mandatory attributes with example values + # model = WebhookEventLogsFilterService() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_webhook_event_type.py b/src/test/test_webhook_event_type.py new file mode 100644 index 0000000000..bb2723a32e --- /dev/null +++ b/src/test/test_webhook_event_type.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.webhook_event_type import WebhookEventType + + +class TestWebhookEventType(unittest.TestCase): + """WebhookEventType unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testWebhookEventType(self): + """Test WebhookEventType""" + # FIXME: construct object with mandatory attributes with example values + # model = WebhookEventType() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_webhook_subscription.py b/src/test/test_webhook_subscription.py new file mode 100644 index 0000000000..0a82ee2e04 --- /dev/null +++ b/src/test/test_webhook_subscription.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.webhook_subscription import WebhookSubscription + + +class TestWebhookSubscription(unittest.TestCase): + """WebhookSubscription unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testWebhookSubscription(self): + """Test WebhookSubscription""" + # FIXME: construct object with mandatory attributes with example values + # model = WebhookSubscription() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_webhook_support.py b/src/test/test_webhook_support.py new file mode 100644 index 0000000000..3cdf18a706 --- /dev/null +++ b/src/test/test_webhook_support.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.webhook_support import WebhookSupport + + +class TestWebhookSupport(unittest.TestCase): + """WebhookSupport unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testWebhookSupport(self): + """Test WebhookSupport""" + # FIXME: construct object with mandatory attributes with example values + # model = WebhookSupport() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/test/test_website.py b/src/test/test_website.py new file mode 100644 index 0000000000..ab20fcf5ef --- /dev/null +++ b/src/test/test_website.py @@ -0,0 +1,35 @@ +""" + Apideck + + The Apideck OpenAPI Spec: SDK Optimized # noqa: E501 + + The version of the OpenAPI document: 8.85.0 + Generated by: https://openapi-generator.tech +""" + + +import sys +import unittest + +import apideck +from apideck.model.website import Website + + +class TestWebsite(unittest.TestCase): + """Website unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testWebsite(self): + """Test Website""" + # FIXME: construct object with mandatory attributes with example values + # model = Website() # noqa: E501 + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/tox.ini b/src/tox.ini new file mode 100644 index 0000000000..1af2010ca9 --- /dev/null +++ b/src/tox.ini @@ -0,0 +1,9 @@ +[tox] +envlist = py3 + +[testenv] +deps=-r{toxinidir}/requirements.txt + -r{toxinidir}/test-requirements.txt + +commands= + pytest --cov=apideck